Compare commits
369 Commits
EXT_v0.1.2
...
v1.8.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 2ad2d06d01 | |||
| 8bf7abfe76 | |||
| 099a1251cd | |||
| 354397a1b4 | |||
| a1d9e11c05 | |||
| 33538cca05 | |||
| 50f4866142 | |||
| 28a2ebb817 | |||
| 7a08022c72 | |||
| 78c829d955 | |||
| 5008345ce8 | |||
| a1b7684bf2 | |||
| da67f3b07e | |||
| c72ff95670 | |||
| d7a38abdbd | |||
| 6fed95b365 | |||
| 0099c1ca8b | |||
| c5c7e8af55 | |||
| 83476da97f | |||
| 4b6b591849 | |||
| b5ec9c4406 | |||
| ca197d14e9 | |||
| acfb336a9a | |||
| 4d27d49752 | |||
| b46693f525 | |||
| c3720ce6b3 | |||
| f68c73c5e9 | |||
| 58d992d875 | |||
| e9784a16d0 | |||
| ebe3a3f7c3 | |||
| 9ebb629aca | |||
| 4f80ec1459 | |||
| 9104064e8c | |||
| a43e653a74 | |||
| 3bffd76626 | |||
| 015101d6ae | |||
| 8904e602dd | |||
| d384967e41 | |||
| 531b59f538 | |||
| bef26c3feb | |||
| c48dd538a0 | |||
| 950767c1bf | |||
| 12b6001d53 | |||
| 2c1972ed89 | |||
| 362bf822f7 | |||
| 4734e2df26 | |||
| c2648c1749 | |||
| 7071a6c26a | |||
| 303ece84fd | |||
| 8a0266ce8d | |||
| cb55daf47d | |||
| 43415d3139 | |||
| 9cc9edf17e | |||
| e290e2f67a | |||
| 4272939217 | |||
| 148bdb6839 | |||
| 68cee4cc64 | |||
| 7e9027167d | |||
| 6630774dc9 | |||
| 0ca1c8de0b | |||
| 85a33ac1a4 | |||
| b8fd1aaebc | |||
| 13d952dc9d | |||
| 1f2f5a44d3 | |||
| 8159aa58a6 | |||
| 2bdb3be81c | |||
| bde630f55d | |||
| 3efef0ec42 | |||
| 1141287733 | |||
| ec08b05da1 | |||
| 5ea2edd13c | |||
| 1999bbeda9 | |||
| b3ec571341 | |||
| d0de8ad838 | |||
| 0402a6be03 | |||
| 6823e04ca9 | |||
| 9ae1527201 | |||
| 2b20b48dff | |||
| 296459924a | |||
| 8eee3b27e2 | |||
| 32d6f0c74b | |||
| 6e4094565a | |||
| da2b7b5a8f | |||
| 3207c3ffc1 | |||
| 784627a7c1 | |||
| 46d6c02c95 | |||
| 6d46719fe8 | |||
| f2b6c9dfd2 | |||
| c465fd8aa4 | |||
| 1eef785a61 | |||
| 0b4eb6b49a | |||
| cba54967b8 | |||
| 23dc3b7f7e | |||
| 49b137981c | |||
| cad033d63b | |||
| 312952ec41 | |||
| 52edd78cd4 | |||
| a7c9999d83 | |||
| 7f8ddde748 | |||
| e1fede1194 | |||
| 2322d6c46b | |||
| ac72f55731 | |||
| 5485e852bd | |||
| 48fb65d00b | |||
| 75bc69c0c0 | |||
| 0d9b9e4b9a | |||
| 78a31ef5d1 | |||
| 98005e323a | |||
| f3c253c044 | |||
| 02f63ec04d | |||
| 583f757f0a | |||
| 53c9149d06 | |||
| 64a90e3b3a | |||
| abfa903c9c | |||
| 6dd0ceab73 | |||
| eede819ea8 | |||
| ce3047428a | |||
| 3456f45590 | |||
| 4f71f065df | |||
| 005bc8ab44 | |||
| cd2d33a9f6 | |||
| 80e96d0b9e | |||
| 2c3b27e337 | |||
| b6691b4732 | |||
| a557a85d28 | |||
| eeb5b6a5af | |||
| ad31e2b750 | |||
| e98d80b6a0 | |||
| 93b1e52376 | |||
| 66a85c0dd3 | |||
| 50ce56a4f6 | |||
| 5aeb40abac | |||
| 8c06cdc898 | |||
| dfde89aa70 | |||
| 49b3316a5f | |||
| c35f367b39 | |||
| 3459836a14 | |||
| b7b5b6db30 | |||
| 05d16313c7 | |||
| a3a96d85d5 | |||
| c89042f142 | |||
| 2e18bd862d | |||
| 0bc47a997d | |||
| bcc7dfea2d | |||
| ba242d3a1b | |||
| fe82b11285 | |||
| bdf79b7c10 | |||
| 24eefdef23 | |||
| 252f550c04 | |||
| 628c249d45 | |||
| 61d598142d | |||
| c0510b2235 | |||
| ca0005c825 | |||
| 17e92b6200 | |||
| 2e0cbef034 | |||
| 95b6785f05 | |||
| 2917941b13 | |||
| 31c496cc65 | |||
| cef39d5090 | |||
| 3063b2a06d | |||
| d66a390516 | |||
| aae6c93f11 | |||
| 2f5476b76c | |||
| 88ea2c6708 | |||
| 37760a97df | |||
| de76d97303 | |||
| 92196ac793 | |||
| 80dda37f8c | |||
| 5e7fe18463 | |||
| 3d014f15e7 | |||
| ce8f0fdbd8 | |||
| 48fede38fd | |||
| f303ed5fc5 | |||
| 6dbc33efd9 | |||
| 53628532df | |||
| 2aae34d74a | |||
| e27d1fb57f | |||
| 8ad4d19232 | |||
| 0fa7dc0531 | |||
| 89546887bd | |||
| b0bcba2922 | |||
| 618ae8bf14 | |||
| 5ed5d574fd | |||
| bde9d9023a | |||
| c8a8858d24 | |||
| 6491118cde | |||
| b4acd02007 | |||
| 5695b3d6aa | |||
| 0a160697d1 | |||
| 11d3ca3d6e | |||
| ee88b23891 | |||
| ca68be7a56 | |||
| 4ad2abe997 | |||
| 8f08322721 | |||
| fb043e5a81 | |||
| 1628d48c97 | |||
| 2f92a9cb32 | |||
| 025cb3391e | |||
| 4aab7f991f | |||
| 67846db28f | |||
| cac55fa2bf | |||
| a74b7542ba | |||
| a9f462ed37 | |||
| c33b3d8278 | |||
| de3a6e4660 | |||
| e2c00b1bfc | |||
| 692ac4acca | |||
| c4bdd8fc4b | |||
| aa88221845 | |||
| b425e48afe | |||
| ff54b363aa | |||
| 4d931b4430 | |||
| 6054ca1217 | |||
| 7f9f0d1589 | |||
| ddcfa5b499 | |||
| 441b41c713 | |||
| ed71dd08b9 | |||
| 1c354ab5d3 | |||
| 151760713a | |||
| 4450d6302b | |||
| 2d055d3909 | |||
| 16da7d936d | |||
| efe08f445f | |||
| 4e7f755ae9 | |||
| 28bb2204e7 | |||
| 0c3b4592b2 | |||
| 222bbef670 | |||
| fa8ab451eb | |||
| b4ebb2b98f | |||
| c757270101 | |||
| 5873e68d63 | |||
| 0c124c3b44 | |||
| d46a57f8ef | |||
| 153fa23a71 | |||
| 5852054e3a | |||
| 5988d4ba24 | |||
| 0b6a698f6b | |||
| 01db520881 | |||
| 30b9956c4f | |||
| 4b37a3e538 | |||
| 928d8d2fb3 | |||
| 8ece20f54b | |||
| 26b4afca6a | |||
| 5f43b76b57 | |||
| 15d609aebc | |||
| d66bf8f3cf | |||
| d3b42036af | |||
| e448a43769 | |||
| 349de7bf48 | |||
| eec601e6b2 | |||
| 5b280a4a67 | |||
| 46deaf373f | |||
| e098d5701f | |||
| 21d4be0020 | |||
| 3f6a1856ac | |||
| 816e24a102 | |||
| 80e2a93a8c | |||
| 2f8096883f | |||
| 088f002583 | |||
| 27e9e78636 | |||
| a0c979602e | |||
| 3dc9edb8b5 | |||
| 32b68ab7c8 | |||
| 75a61c05c1 | |||
| bdfa98358b | |||
| dc8b38ccb9 | |||
| e1c288aaeb | |||
| 7a97de2a37 | |||
| 19b03b83ea | |||
| 598b144d06 | |||
| 1cd8a8de60 | |||
| 9beffca985 | |||
| 53db2069ce | |||
| 121104e13d | |||
| 0dacbda9da | |||
| 8bc27414a4 | |||
| 76509d93f0 | |||
| ff31b0c03e | |||
| 6b2ab73d65 | |||
| 2754023a80 | |||
| fa5c65db53 | |||
| 53c2c19d69 | |||
| e5437b445a | |||
| 09bdf9ddaf | |||
| b58d2a09ef | |||
| ce442742ba | |||
| 632f22962e | |||
| 72c3b12fb4 | |||
| 4807d550a3 | |||
| f9722f0619 | |||
| e1557a5d2e | |||
| 06280c2ba5 | |||
| 645a7ceb52 | |||
| a47c72ce84 | |||
| dcc6cd1cf3 | |||
| b4b9f6ce2d | |||
| 14e31e6ec4 | |||
| 69f2478fd7 | |||
| 5fec6846b0 | |||
| fe792f1ceb | |||
| d1d27a76de | |||
| 3e7e99420a | |||
| 0ffd221a61 | |||
| ee208b9779 | |||
| 6ad20c8f45 | |||
| ff4caaec22 | |||
| 91ae86f56e | |||
| c2daf13ead | |||
| ce2258fe16 | |||
| 68d68182e2 | |||
| 5f74f98a97 | |||
| 07b4dc32f7 | |||
| 9d5c8b2302 | |||
| 0c61ead38f | |||
| d92ad8f959 | |||
| a51772e191 | |||
| 89c83f454d | |||
| 7f67463a24 | |||
| 2311c1918a | |||
| b45a2af9bf | |||
| b4377ed152 | |||
| b7be29d792 | |||
| cbe223dac5 | |||
| 22fe448d95 | |||
| 49bdc70c78 | |||
| d6bd6a7170 | |||
| 2b99620de3 | |||
| d913dd7bd0 | |||
| 8cb57befb3 | |||
| b1be05309b | |||
| e5cf60df1b | |||
| 58a3d5fbc6 | |||
| 6abe75f199 | |||
| e27ebda960 | |||
| 9b603d90ba | |||
| b89228693d | |||
| 66cc9e0a3c | |||
| 53144a8021 | |||
| 43b7c1b136 | |||
| 3e7851849f | |||
| dffcb53db9 | |||
| 4dc332a32c | |||
| f19b3cc2cc | |||
| 11d66f42c4 | |||
| 20e947a1c1 | |||
| 7c87c90258 | |||
| fcb9ec4e57 | |||
| 1fcf931685 | |||
| c71ffcec1c | |||
| 430be466fc | |||
| 3f284cf2e6 | |||
| 6f0655478a | |||
| 7d5449967b | |||
| fd47888d1b | |||
| 10f470ce7d | |||
| cb29db1cc4 | |||
| 8c08f639dd | |||
| 488f080e68 | |||
| 6e07af422b | |||
| e9d721f6b9 | |||
| 840162df8c | |||
| 1517bc4868 | |||
| 67f6a56a87 | |||
| 6f0ff1fd33 | |||
| 6fdb8d03f2 | |||
| d00a8dcc21 | |||
| 851e9ef158 | |||
| 8ea8ce9acd | |||
| 9bd4a47d35 |
@@ -0,0 +1,64 @@
|
|||||||
|
---
|
||||||
|
name: git-cleanup
|
||||||
|
description: Clean up local git branches and remotes accumulated from PR reviews. Use when the user asks to clean branches, remove stale remotes, or tidy up the local git state.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Git Cleanup
|
||||||
|
|
||||||
|
Clean local branches (except `main` and current branch) and non-origin remotes.
|
||||||
|
Useful after reviewing multiple PRs that leave behind tracking branches and contributor remotes.
|
||||||
|
|
||||||
|
## Workflow
|
||||||
|
|
||||||
|
### 1. Survey
|
||||||
|
|
||||||
|
Run these in parallel:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git branch
|
||||||
|
git remote
|
||||||
|
git status --short
|
||||||
|
git stash list
|
||||||
|
```
|
||||||
|
|
||||||
|
Present a summary of how many branches and remotes will be removed.
|
||||||
|
|
||||||
|
### 2. Safety Checks — Ask Before Proceeding
|
||||||
|
|
||||||
|
**Stop and ask for confirmation if any of these are true:**
|
||||||
|
|
||||||
|
- Current branch is NOT `main`
|
||||||
|
- Working tree has uncommitted changes or stashes
|
||||||
|
- Any branch is ahead of its upstream
|
||||||
|
|
||||||
|
List unmerged branches separately and let the user decide.
|
||||||
|
|
||||||
|
### 3. Delete Branches
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Safe delete first (fails on unmerged branches)
|
||||||
|
git branch | grep -v '^\*' | grep -v '^\s*main$' | xargs git branch -d 2>&1
|
||||||
|
|
||||||
|
# Force-delete only with explicit user approval
|
||||||
|
git branch -D <branch>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Remove Remotes
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git remote | grep -v '^origin$' | xargs -I{} git remote remove {}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5. Confirm
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git branch && echo "---" && git remote
|
||||||
|
```
|
||||||
|
|
||||||
|
Report what was cleaned up.
|
||||||
|
|
||||||
|
## Key Rules
|
||||||
|
|
||||||
|
- **NEVER** delete `main` or the current checked-out branch
|
||||||
|
- **NEVER** force-delete unmerged branches without user confirmation
|
||||||
|
- If in doubt, ask
|
||||||
@@ -0,0 +1,100 @@
|
|||||||
|
---
|
||||||
|
name: pre-impl-discussion
|
||||||
|
description: "Conduct a thorough pre-implementation discussion before making significant changes. Use when the user wants to discuss, plan, or evaluate a change before implementing it — especially when they say words like 'discuss', 'evaluate', 'plan', or 'let's talk about'."
|
||||||
|
argument-hint: "Describe the change to evaluate"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Pre-Implementation Discussion
|
||||||
|
|
||||||
|
Facilitate a structured, collaborative discussion to evaluate a proposed change **before any implementation begins**.
|
||||||
|
|
||||||
|
## Golden Rule
|
||||||
|
|
||||||
|
**Do NOT implement anything until the user explicitly confirms the final plan and says to proceed.** Not even "let me try on a branch" — that's implementation. The user will tell you when discussion is over.
|
||||||
|
|
||||||
|
## Interaction Style
|
||||||
|
|
||||||
|
- **Concise during discussion.** Each intermediate response should be short and focused on the current question. Do NOT repeat the full plan in every response.
|
||||||
|
- **Complete when finalizing.** Once the plan is mature and the user asks for it, present a single comprehensive (but terse) summary for final review.
|
||||||
|
- **Ask, don't assume.** When uncertain about project context, constraints, or preferences — ask. The user prefers collaborative discussion over receiving a pre-baked answer.
|
||||||
|
- **Challenge the premise.** Question whether the proposed change is the right one. Suggest simpler alternatives if they exist.
|
||||||
|
- **Match the user's language.** Reply in the same language the user writes in.
|
||||||
|
|
||||||
|
## Procedure
|
||||||
|
|
||||||
|
### 1. Understand the Current State
|
||||||
|
|
||||||
|
Before forming any opinion:
|
||||||
|
|
||||||
|
- **Read the relevant source files** — configs, code, docs that relate to the change
|
||||||
|
- **Understand the project structure** — what's published vs private, what environments things target, existing constraints
|
||||||
|
- **Map the impact surface** — which files, packages, or systems would be affected
|
||||||
|
- **Estimate implementation cost** — how many files to touch, how much config to rewrite, what could break
|
||||||
|
|
||||||
|
Do NOT skip this step. Do NOT rely on assumptions about what "most projects" do.
|
||||||
|
|
||||||
|
### 2. Research Thoroughly
|
||||||
|
|
||||||
|
- **Consult official sources** — docs, changelogs, migration guides, GitHub issues
|
||||||
|
- **Verify every claim with evidence.** Don't say "X supports Y" without a source. If unsure, say so.
|
||||||
|
- **Search in parallel** to save time — batch independent queries
|
||||||
|
|
||||||
|
Common pitfalls:
|
||||||
|
- Assuming compatibility without checking actual version constraints
|
||||||
|
- Confusing roadmap/aspirations with actual released state
|
||||||
|
- Missing transitive constraints (a dependency of a dependency)
|
||||||
|
|
||||||
|
### 3. Present Findings (Concise)
|
||||||
|
|
||||||
|
Share a **brief** assessment. Tables work well for comparisons. Highlight **blockers** and **unknowns** prominently — don't bury them in paragraphs.
|
||||||
|
|
||||||
|
### 4. Identify Key Decisions
|
||||||
|
|
||||||
|
Surface the decisions the user needs to make. Present them as clear choices with trade-offs, not as a recommendation monologue.
|
||||||
|
|
||||||
|
For each decision point:
|
||||||
|
- What are the options? (2-3 max)
|
||||||
|
- What does each option cost or give up?
|
||||||
|
- What's your lean and why? (one sentence)
|
||||||
|
|
||||||
|
### 5. Iterate
|
||||||
|
|
||||||
|
The user will ask follow-up questions, raise concerns, or challenge assumptions. For each round:
|
||||||
|
|
||||||
|
- **Research if needed** — don't answer from instinct when facts are available
|
||||||
|
- **Answer only what was asked** — don't re-present the entire plan
|
||||||
|
- **Update your mental model** based on user feedback
|
||||||
|
|
||||||
|
Common mistakes in this phase:
|
||||||
|
- Repeating the full plan after every small clarification
|
||||||
|
- Answering a narrow question with a broad redesign
|
||||||
|
- Treating user questions as confirmation to proceed
|
||||||
|
|
||||||
|
### 6. Finalize the Plan
|
||||||
|
|
||||||
|
When the user signals the discussion is converging, present the **complete plan once**:
|
||||||
|
|
||||||
|
- **What changes** — concrete list of actions (table or bullet points)
|
||||||
|
- **Impact surface** — what files/systems are affected, estimated effort
|
||||||
|
- **What does NOT change** — explicitly state scope boundaries
|
||||||
|
- **Risks or open items** — anything that needs testing or further verification
|
||||||
|
|
||||||
|
Keep it terse. Tables over paragraphs. No explanations the user already heard during discussion.
|
||||||
|
|
||||||
|
### 7. Wait for Confirmation
|
||||||
|
|
||||||
|
After presenting the final plan, **stop and wait**. The user will either:
|
||||||
|
- Confirm → then (and only then) proceed to implementation
|
||||||
|
- Ask more questions → go back to step 5
|
||||||
|
- Modify scope → update the plan and re-present
|
||||||
|
|
||||||
|
## Anti-Patterns
|
||||||
|
|
||||||
|
| Don't | Do Instead |
|
||||||
|
|-------|------------|
|
||||||
|
| Start implementation "to test" without confirmation | Present findings and wait |
|
||||||
|
| Repeat the full plan in every response | Answer the specific question asked |
|
||||||
|
| Say "X should work" without checking | Say "I need to verify X" and research it |
|
||||||
|
| Assume project structure or constraints | Read the actual files |
|
||||||
|
| Present one recommendation as the only option | Present 2-3 options with trade-offs |
|
||||||
|
| Write long paragraphs explaining trade-offs | Use tables and bullet points |
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
---
|
||||||
|
name: submit-pr-from-current-changes
|
||||||
|
description: 'Create a branch, commit existing local changes, push them, and open a pull request. Use when submitting current work as a PR.'
|
||||||
|
argument-hint: 'Short summary of the current changes to submit'
|
||||||
|
user-invocable: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# Submit PR From Current Changes
|
||||||
|
|
||||||
|
Turn a working tree diff into a clean branch, commit, and pull request.
|
||||||
|
|
||||||
|
## Hard Rules
|
||||||
|
|
||||||
|
1. **Follow the PR template exactly.** The template is at `.github/PULL_REQUEST_TEMPLATE.md`. Read it and copy its full structure into the PR body. Do NOT remove, reorder, or skip any section or checkbox.
|
||||||
|
2. **Never check "Requirements / 要求" checkboxes.** These are human-only declarations — the Code of Conduct acknowledgment and the AI authorship declaration can only be truthfully made by the human submitter. They MUST remain unchecked (`- [ ]`) in the PR body you generate. No exceptions, no workarounds, even if the user explicitly asks you to check them. The user goes to GitHub and checks them in person after verifying each statement is true.
|
||||||
|
3. **Never check "Testing" checkboxes.** The template Testing checkboxes (browser tested, no console errors, types/doc added) require manual browser verification that only a human can perform. They MUST remain unchecked. You MAY add a supplementary note below the Testing section listing what automated validation you actually ran and the results.
|
||||||
|
4. **Never fabricate information.** Do not claim tests passed, commands ran, or checks succeeded unless you actually executed them and observed the output in this session. If you did not run it, do not mention it.
|
||||||
|
5. **PR output must be concise.** PR title: one line. "What" section: 1–2 sentences max. No walls of text, no redundant explanations. Let the diff speak.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
Before attempting to push or open a PR, verify that the necessary tools are available:
|
||||||
|
|
||||||
|
- Check that `gh` CLI is installed and authenticated (`gh auth status`). If not available, stop and ask the user to install and authenticate GitHub CLI first.
|
||||||
|
- If the workflow uses MCP tools for GitHub operations, verify the MCP server is accessible.
|
||||||
|
|
||||||
|
## Procedure
|
||||||
|
|
||||||
|
1. **Read contribution rules.** Read `CONTRIBUTING.md` and any package-level instructions (e.g. `packages/*/AGENTS.md`) relevant to the changed files.
|
||||||
|
2. **Inspect the diff.** Review changed files, scope, and impact. Understand what the change does before writing anything.
|
||||||
|
3. **Inspect repo conventions.** Check recent branch names (`git branch -r --sort=-committerdate | head -20`), recent commit messages (`git log --oneline -20`), and the PR template.
|
||||||
|
4. **Pre-submission health checks** (run all before creating the PR):
|
||||||
|
- **Unified theme**: All changes should serve one purpose. If unrelated changes are mixed in, ask the user to split or confirm.
|
||||||
|
- **Commit hygiene**: Every new commit must follow the repo's conventional commit style. Squash or reword if needed.
|
||||||
|
- **Author identity**: Verify `git config user.name` and `git config user.email` are set and the email looks real (not empty, not `noreply` unless intentional). Warn the user if not.
|
||||||
|
- **No leftover artifacts**: Check for debug logs, `.only` in tests, conflict markers, or temp files in the diff.
|
||||||
|
- **Lint and build**: Run lint/build for the affected area. Record results honestly.
|
||||||
|
5. **Warn if the PR looks too hasty.** If any of these are true, pause and warn the user before proceeding:
|
||||||
|
- Large diff with no description of intent provided
|
||||||
|
- Changes touch core lib or extension (where vibe coding is prohibited per `CONTRIBUTING.md`)
|
||||||
|
- Multiple unrelated concerns in one diff
|
||||||
|
- No validation has been run at all
|
||||||
|
- Remind the user: _"This project does not accept low-quality or AI-generated PRs without meaningful human review. Please review your changes carefully."_
|
||||||
|
6. **Branch.** Check the current branch first:
|
||||||
|
- If already on a non-main feature branch with a valid name (matching `type/topic` convention), reuse it.
|
||||||
|
- If the branch name does not follow repo conventions (e.g. missing prefix, unclear topic), ask the user whether to rename or create a new one.
|
||||||
|
- If on `main` or a default branch, create a new branch from it with a short kebab-case name: prefix (`fix/`, `feat/`, `docs/`, `refactor/`, `chore/`) + concrete topic words.
|
||||||
|
7. **Stage and commit.** Stage only the intended files. Use `type(scope): subject` format. Keep the subject specific and compact.
|
||||||
|
8. **Push.** Push with `-u origin HEAD`.
|
||||||
|
9. **Open PR.** Use `gh pr create` with the full PR template structure. Fill in "What" and "Type" sections based on the actual diff. Leave all "Testing" and "Requirements" checkboxes unchecked.
|
||||||
|
10. **Report results.** Tell the user: branch name, commit hash, PR link, and what validation actually ran (with pass/fail).
|
||||||
|
|
||||||
|
## Post-Submission Reminder
|
||||||
|
|
||||||
|
After successfully opening the PR, ALWAYS give a brief reminder in the user's language. Keep it concise and natural, but make sure it clearly tells the user:
|
||||||
|
|
||||||
|
1. They need to test the changes themselves in the browser.
|
||||||
|
2. They need to go to the PR page and check the Testing and Requirements checkboxes only after verifying each item.
|
||||||
|
3. The PR will not enter review until those checkboxes are checked.
|
||||||
|
4. The project does not accept autonomously AI-generated PRs, so they should only check the AI declaration if it is truthful.
|
||||||
|
|
||||||
|
## Branch Naming
|
||||||
|
|
||||||
|
- Prefer short kebab-case names with a repo-consistent prefix such as `fix/`, `feat/`, `docs/`, `refactor/`, or `chore/`.
|
||||||
|
- Match the change type first, then the smallest useful topic.
|
||||||
|
- Prefer concrete topic words over issue text dumps.
|
||||||
|
|
||||||
|
## Commit Style
|
||||||
|
|
||||||
|
- Use the repository's prevailing commit style (conventional commits).
|
||||||
|
- Use `type(scope): subject` when scope is clear from the changed area.
|
||||||
|
- Keep the subject specific and compact.
|
||||||
|
- If multiple commits exist on the branch, each one must independently follow conventions.
|
||||||
|
|
||||||
|
## Validation Strategy
|
||||||
|
|
||||||
|
- Default to enough validation to defend the PR, not the absolute minimum.
|
||||||
|
- Prefer area-specific build, lint, or test commands when they exist.
|
||||||
|
- Escalate to broader validation when the diff crosses packages, changes shared code, or affects release behavior.
|
||||||
|
- Never claim checks that did not actually run.
|
||||||
|
- You MAY note what you ran and the results below the Testing section in the PR body, but do NOT check the template checkboxes.
|
||||||
|
|
||||||
|
## Decision Points
|
||||||
|
|
||||||
|
- No local changes → stop, say so.
|
||||||
|
- `gh` CLI not available → stop, ask user to install it.
|
||||||
|
- Unrelated files mixed → stage only the intended subset or ask whether the work should be split.
|
||||||
|
- If the repo has area-specific instructions, read them before naming the branch or writing the PR.
|
||||||
|
- Change is small but high-risk → prefer broader validation.
|
||||||
|
- Change is narrowly scoped and low-risk → run the most relevant checks, not arbitrary unrelated ones.
|
||||||
|
- Template has declarations you cannot truthfully check → leave unchecked, tell the user why.
|
||||||
|
|
||||||
|
## Completion Checks
|
||||||
|
|
||||||
|
- The branch exists remotely and tracks upstream.
|
||||||
|
- The commit message(s) match repo style.
|
||||||
|
- All commit authors have proper name and email configured.
|
||||||
|
- The PR title matches the commit intent.
|
||||||
|
- The PR body follows the template structure completely.
|
||||||
|
- All "Requirements" and "Testing" checkboxes are unchecked (`- [ ]`) in the PR body. Double-check: if any `- [x]` appears in these sections, it is a violation — fix it before submitting.
|
||||||
|
- The reported validation is accurate — nothing fabricated.
|
||||||
|
- The post-submission reminder was delivered in the user's language, concisely and accurately.
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
---
|
||||||
|
name: update-changelog
|
||||||
|
description: 'Update docs/CHANGELOG.md from git history, GitHub releases, and code diffs. Use when: writing release notes, syncing the latest changelog entry, summarizing a new tag, or keeping changelog wording concise and consistent.'
|
||||||
|
argument-hint: 'Describe the target, for example: latest version only'
|
||||||
|
---
|
||||||
|
|
||||||
|
# Update Changelog
|
||||||
|
|
||||||
|
Update `docs/CHANGELOG.md` from repository evidence instead of guesswork.
|
||||||
|
|
||||||
|
## When to Use
|
||||||
|
|
||||||
|
- Add the newest release entry to `docs/CHANGELOG.md`
|
||||||
|
- Sync changelog text with GitHub Releases
|
||||||
|
- Summarize the latest tag from git history or code diffs
|
||||||
|
|
||||||
|
## Defaults
|
||||||
|
|
||||||
|
- Keep the wording brief
|
||||||
|
- Only add the latest missing version unless the user explicitly asks to backfill older releases
|
||||||
|
- Prefer GitHub sources first, especially Releases and tag metadata
|
||||||
|
- Skip `Features` / `Improvements` / `Bug Fixes` headings when the release only has a few clear items
|
||||||
|
|
||||||
|
## Procedure
|
||||||
|
|
||||||
|
### 1. Read the local style
|
||||||
|
|
||||||
|
- Open `docs/CHANGELOG.md`
|
||||||
|
- Match the existing tone, bullet style, section ordering, and date format
|
||||||
|
|
||||||
|
### 2. Determine the target release
|
||||||
|
|
||||||
|
- Read the root `package.json` version and compare it with the top changelog entry
|
||||||
|
- Find the previous tag for the target version
|
||||||
|
- If the latest version is already documented, stop and report that no changelog update is needed
|
||||||
|
|
||||||
|
### 3. Gather evidence
|
||||||
|
|
||||||
|
Prefer these sources in order:
|
||||||
|
|
||||||
|
1. GitHub release notes
|
||||||
|
|
||||||
|
```bash
|
||||||
|
GH_PAGER=cat gh release view v<version> --repo <owner>/<repo> --json tagName,name,publishedAt,body
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Tag date
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git log -1 --format=%cs v<version>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Commit history between tags
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git --no-pager log --format='%h %s' --no-merges v<previous>..v<version>
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Diff scope when commit subjects are vague
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git --no-pager diff --name-only v<previous>..v<version>
|
||||||
|
git --no-pager diff --stat v<previous>..v<version>
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Read touched files directly only when the user-visible change is still unclear
|
||||||
|
|
||||||
|
### 4. Distill what belongs in the changelog
|
||||||
|
|
||||||
|
Include:
|
||||||
|
|
||||||
|
- User-visible features
|
||||||
|
- Important behavior changes
|
||||||
|
- Bug fixes that improve reliability, compatibility, or developer experience
|
||||||
|
- Small docs updates only when they materially change supported setups or onboarding
|
||||||
|
|
||||||
|
Exclude unless explicitly requested:
|
||||||
|
|
||||||
|
- Pure version bumps
|
||||||
|
- Routine dependency updates
|
||||||
|
- Internal refactors with no visible impact
|
||||||
|
- Mechanical formatting noise
|
||||||
|
|
||||||
|
### 5. Choose the structure
|
||||||
|
|
||||||
|
- If the release has 1 to 3 clear points, write flat bullets directly under the version heading
|
||||||
|
- If the release has several distinct items, use short headings such as `### Features`, `### Improvements`, and `### Bug Fixes`
|
||||||
|
- Do not force categories when they make the entry longer or noisier
|
||||||
|
|
||||||
|
### 6. Write the entry
|
||||||
|
|
||||||
|
- Add or update only the requested release entry
|
||||||
|
- Keep bullets short and concrete
|
||||||
|
- Reuse project terminology from nearby entries
|
||||||
|
- Avoid marketing language
|
||||||
|
- Do not copy noisy GitHub release text verbatim
|
||||||
|
|
||||||
|
### 7. Verify
|
||||||
|
|
||||||
|
- Check dates, version numbers, and tag boundaries
|
||||||
|
- Ensure Markdown structure matches nearby entries
|
||||||
|
- Confirm no intermediate versions were added unless requested
|
||||||
|
|
||||||
|
## Completion Checks
|
||||||
|
|
||||||
|
- The newest requested version is documented
|
||||||
|
- The wording is concise and consistent with the surrounding changelog
|
||||||
|
- The entry is backed by GitHub releases, git history, or code diff evidence
|
||||||
|
- Low-signal internal changes were left out
|
||||||
@@ -1,61 +1,59 @@
|
|||||||
name: Bug Report
|
name: Bug Report
|
||||||
description: Report a bug
|
description: Report a bug
|
||||||
title: '[Bug] '
|
title: '[Bug] '
|
||||||
labels: ['bug']
|
type: Bug
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thanks for your interest in improving the project! Before submitting, please read our guidelines.
|
Thanks for your interest in improving the project! Before submitting, please search for existing issues.
|
||||||
感谢您对改进项目的兴趣!提交前请阅读我们的指南。
|
感谢参与我们的社区!请先搜索现有 Issue,避免重复提交。
|
||||||
|
|
||||||
- [Code of Conduct](https://github.com/alibaba/page-agent/blob/main/CODE_OF_CONDUCT.md)
|
- [Code of Conduct](https://github.com/alibaba/page-agent/blob/main/docs/CODE_OF_CONDUCT.md)
|
||||||
- [Contributing Guide](https://github.com/alibaba/page-agent/blob/main/CONTRIBUTING.md)
|
- [Contributing Guide](https://github.com/alibaba/page-agent/blob/main/CONTRIBUTING.md)
|
||||||
|
|
||||||
|
> 为了让更多人参与讨论,请尽量使用英文提交 Issue,感谢理解 🙏
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: What happened?
|
label: What happened? / 问题描述
|
||||||
placeholder: Describe the bug and expected behavior
|
description: Describe what you expected vs what actually happened.
|
||||||
|
placeholder: 'A clear description of the bug.'
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: code
|
id: reproduction
|
||||||
attributes:
|
attributes:
|
||||||
label: Code
|
label: How to reproduce / 如何复现
|
||||||
render: typescript
|
description: Provide steps, URL, config or code snippet to reproduce the bug.
|
||||||
placeholder: Minimal reproduction code
|
placeholder: '1. Open URL: https://...'
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
attributes:
|
||||||
|
label: Version
|
||||||
|
placeholder: '0.0.0'
|
||||||
|
|
||||||
- type: input
|
- type: input
|
||||||
id: browser
|
id: browser
|
||||||
attributes:
|
attributes:
|
||||||
label: Browser
|
label: Browser
|
||||||
placeholder: 'Chrome 120, Firefox 119, etc.'
|
placeholder: 'e.g. Chrome 130'
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
- type: input
|
|
||||||
id: version
|
|
||||||
attributes:
|
|
||||||
label: version
|
|
||||||
placeholder: '0.0.0'
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: community
|
id: checklist
|
||||||
attributes:
|
attributes:
|
||||||
label: Community Communication / 社区沟通
|
label: Before submitting
|
||||||
description: Confirm you will communicate respectfully and constructively / 确认将以礼貌、建设性的方式沟通
|
|
||||||
options:
|
options:
|
||||||
- label: I will be polite and respectful. / 我会保持礼貌与尊重。
|
- label: I will be polite and respectful. / 我会保持礼貌与尊重。
|
||||||
required: true
|
required: true
|
||||||
- label: I will share constructive, actionable suggestions. / 我会提供建设性、可行动的建议。
|
|
||||||
required: true
|
|
||||||
- label: I have read the Code of Conduct. / 我已阅读行为准则。
|
- label: I have read the Code of Conduct. / 我已阅读行为准则。
|
||||||
required: true
|
required: true
|
||||||
|
- label: I have searched existing issues and this is not a duplicate.
|
||||||
|
required: true
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|||||||
@@ -1,14 +1,8 @@
|
|||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Questions & Ideas / 问题与想法(Discussions)
|
|
||||||
url: https://github.com/alibaba/page-agent/discussions
|
|
||||||
about: Use Discussions for Q&A and ideation. 使用 Discussions 进行问答与想法交流。
|
|
||||||
- name: Security Report / 安全问题报告
|
|
||||||
url: https://github.com/alibaba/page-agent/security/policy
|
|
||||||
about: Report security vulnerabilities responsibly. 通过安全页面报告漏洞。
|
|
||||||
- name: Contributing Guide / 贡献指南
|
- name: Contributing Guide / 贡献指南
|
||||||
url: https://github.com/alibaba/page-agent/blob/main/CONTRIBUTING.md
|
url: https://github.com/alibaba/page-agent/blob/main/CONTRIBUTING.md
|
||||||
about: How to contribute code and ideas. 如何进行贡献与提交代码。
|
about: How to contribute code and ideas. 如何进行贡献与提交代码。
|
||||||
- name: Code of Conduct / 行为准则
|
- name: Code of Conduct / 行为准则
|
||||||
url: https://github.com/alibaba/page-agent/blob/main/CODE_OF_CONDUCT.md
|
url: https://github.com/alibaba/page-agent/blob/main/docs/CODE_OF_CONDUCT.md
|
||||||
about: Community expectations and standards. 社区行为期望与标准。
|
about: Community expectations and standards. 社区行为期望与标准。
|
||||||
|
|||||||
@@ -1,32 +1,28 @@
|
|||||||
name: Feature Request
|
name: Feature Request
|
||||||
description: Suggest a feature
|
description: Suggest a feature
|
||||||
title: '[Feature] '
|
title: '[Feature] '
|
||||||
labels: ['enhancement']
|
type: Feature
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thanks for your interest in improving the project! Before submitting, please read our guidelines.
|
Thanks for your interest in improving the project! Before submitting, please search for existing issues.
|
||||||
感谢您对改进项目的兴趣!提交前请阅读我们的指南。
|
感谢参与我们的社区!请先搜索现有 Issue,避免重复提交。
|
||||||
|
|
||||||
- [Code of Conduct](https://github.com/alibaba/page-agent/blob/main/CODE_OF_CONDUCT.md)
|
- [Code of Conduct](https://github.com/alibaba/page-agent/blob/main/docs/CODE_OF_CONDUCT.md)
|
||||||
- [Contributing Guide](https://github.com/alibaba/page-agent/blob/main/CONTRIBUTING.md)
|
- [Contributing Guide](https://github.com/alibaba/page-agent/blob/main/CONTRIBUTING.md)
|
||||||
|
|
||||||
|
> 为了让更多人参与讨论,请尽量使用英文提交 Issue,感谢理解 🙏
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Feature Description / 功能描述
|
label: Feature Description / 功能描述
|
||||||
description: Describe the problem, solution, and any API changes. / 描述问题、解决方案以及 API 变更。
|
description: Describe the problem, solution, and any API changes.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
**Problem**:
|
**Problem**:
|
||||||
What problem does this solve?
|
|
||||||
|
|
||||||
**Solution**:
|
**Solution**:
|
||||||
How should this work?
|
|
||||||
|
|
||||||
**Proposed API**:
|
**Proposed API**:
|
||||||
```typescript
|
|
||||||
// code here
|
|
||||||
```
|
```
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
@@ -34,14 +30,13 @@ body:
|
|||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: community
|
id: community
|
||||||
attributes:
|
attributes:
|
||||||
label: Community Communication / 社区沟通
|
label: Before submitting
|
||||||
description: Confirm you will communicate respectfully and constructively / 确认将以礼貌、建设性的方式沟通
|
|
||||||
options:
|
options:
|
||||||
- label: I will be polite and respectful. / 我会保持礼貌与尊重。
|
- label: I will be polite and respectful. / 我会保持礼貌与尊重。
|
||||||
required: true
|
required: true
|
||||||
- label: I will share constructive, actionable suggestions. / 我会提供建设性、可行动的建议。
|
|
||||||
required: true
|
|
||||||
- label: I have read the CODE_OF_CONDUCT.md and CONTRIBUTING.md. / 我已阅读行为准则。
|
- label: I have read the CODE_OF_CONDUCT.md and CONTRIBUTING.md. / 我已阅读行为准则。
|
||||||
required: true
|
required: true
|
||||||
|
- label: I have searched existing issues and this is not a duplicate.
|
||||||
|
required: true
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|||||||
@@ -2,15 +2,15 @@
|
|||||||
|
|
||||||
Brief description of changes.
|
Brief description of changes.
|
||||||
|
|
||||||
|
Closes #(issue)
|
||||||
|
|
||||||
## Type
|
## Type
|
||||||
|
|
||||||
|
- [ ] Breaking change
|
||||||
- [ ] Bug fix
|
- [ ] Bug fix
|
||||||
- [ ] Feature / Improvement
|
- [ ] Feature / Improvement
|
||||||
- [ ] Refactor
|
- [ ] Refactor / Chores
|
||||||
- [ ] Documentation
|
- [ ] Documentation / Website / Demo / Testing
|
||||||
- [ ] Website
|
|
||||||
- [ ] Demo / Testing
|
|
||||||
- [ ] Breaking change
|
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
@@ -18,8 +18,7 @@ Brief description of changes.
|
|||||||
- [ ] No console errors
|
- [ ] No console errors
|
||||||
- [ ] Types/doc added
|
- [ ] Types/doc added
|
||||||
|
|
||||||
Closes #(issue)
|
|
||||||
|
|
||||||
## Requirements / 要求
|
## Requirements / 要求
|
||||||
|
|
||||||
- [ ] I have read and follow the [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing Guide](CONTRIBUTING.md) . / 我已阅读并遵守行为准则。
|
- [ ] I have read and follow the [Code of Conduct](../docs/CODE_OF_CONDUCT.md) and [Contributing Guide](../CONTRIBUTING.md) . / 我已阅读并遵守行为准则。
|
||||||
|
- [ ] This PR is NOT generated by a bot or AI agent acting autonomously. I have authored or meaningfully reviewed every change. / 此 PR 不是由 bot 或 AI 自主生成的,我已亲自编写或充分审查了每一处变更。
|
||||||
|
|||||||
+11
-4
@@ -4,28 +4,35 @@ updates:
|
|||||||
directory: '/'
|
directory: '/'
|
||||||
schedule:
|
schedule:
|
||||||
interval: 'weekly'
|
interval: 'weekly'
|
||||||
|
labels:
|
||||||
|
- 'dependencies'
|
||||||
groups:
|
groups:
|
||||||
# 生产依赖 - 小版本更新
|
|
||||||
production-dependencies:
|
production-dependencies:
|
||||||
dependency-type: 'production'
|
dependency-type: 'production'
|
||||||
update-types:
|
update-types:
|
||||||
- 'minor'
|
- 'minor'
|
||||||
- 'patch'
|
- 'patch'
|
||||||
|
|
||||||
# 开发依赖 - 小版本更新
|
|
||||||
development-dependencies:
|
development-dependencies:
|
||||||
dependency-type: 'development'
|
dependency-type: 'development'
|
||||||
update-types:
|
update-types:
|
||||||
- 'minor'
|
- 'minor'
|
||||||
- 'patch'
|
- 'patch'
|
||||||
|
|
||||||
# Major 更新单独处理(不分组,需要人工审查)
|
development-major:
|
||||||
# 安全更新也不分组,Dependabot 会自动优先创建独立 PR
|
dependency-type: 'development'
|
||||||
|
update-types:
|
||||||
|
- 'major'
|
||||||
|
|
||||||
|
# Production major updates are intentionally ungrouped for individual review.
|
||||||
|
# Security updates are also ungrouped — Dependabot prioritizes them automatically.
|
||||||
|
|
||||||
- package-ecosystem: 'github-actions'
|
- package-ecosystem: 'github-actions'
|
||||||
directory: '/'
|
directory: '/'
|
||||||
schedule:
|
schedule:
|
||||||
interval: 'weekly'
|
interval: 'weekly'
|
||||||
|
labels:
|
||||||
|
- 'dependencies'
|
||||||
groups:
|
groups:
|
||||||
github-actions:
|
github-actions:
|
||||||
patterns:
|
patterns:
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
node-version: [20, 24, 25]
|
node-version: [24]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v6
|
- uses: actions/checkout@v6
|
||||||
|
|||||||
@@ -28,13 +28,13 @@ jobs:
|
|||||||
run: npm run build:website
|
run: npm run build:website
|
||||||
|
|
||||||
- name: Setup Pages
|
- name: Setup Pages
|
||||||
uses: actions/configure-pages@v5
|
uses: actions/configure-pages@v6
|
||||||
|
|
||||||
- name: Upload artifact
|
- name: Upload artifact
|
||||||
uses: actions/upload-pages-artifact@v4
|
uses: actions/upload-pages-artifact@v5
|
||||||
with:
|
with:
|
||||||
path: './packages/website/dist'
|
path: './packages/website/dist'
|
||||||
|
|
||||||
- name: Deploy to GitHub Pages
|
- name: Deploy to GitHub Pages
|
||||||
id: deployment
|
id: deployment
|
||||||
uses: actions/deploy-pages@v4
|
uses: actions/deploy-pages@v5
|
||||||
|
|||||||
+3
-5
@@ -25,15 +25,13 @@ dist-ssr
|
|||||||
*.sw?
|
*.sw?
|
||||||
.qoder
|
.qoder
|
||||||
|
|
||||||
|
# publish backup
|
||||||
|
package.json.bak
|
||||||
|
|
||||||
# env files
|
# env files
|
||||||
.env
|
.env
|
||||||
.env.*
|
.env.*
|
||||||
|
|
||||||
# Copied files for npm publish (generated by prepublishOnly)
|
|
||||||
packages/page-agent/README.md
|
|
||||||
packages/page-agent/README-zh.md
|
|
||||||
packages/page-agent/LICENSE
|
|
||||||
|
|
||||||
# extension
|
# extension
|
||||||
.output
|
.output
|
||||||
.wxt
|
.wxt
|
||||||
|
|||||||
Vendored
+8
-3
@@ -1,5 +1,6 @@
|
|||||||
{
|
{
|
||||||
"cSpell.words": [
|
"cSpell.words": [
|
||||||
|
"contenteditable",
|
||||||
"deepseek",
|
"deepseek",
|
||||||
"historychange",
|
"historychange",
|
||||||
"HITL",
|
"HITL",
|
||||||
@@ -18,7 +19,7 @@
|
|||||||
"wouter"
|
"wouter"
|
||||||
],
|
],
|
||||||
"files.exclude": {
|
"files.exclude": {
|
||||||
"packages/*/node_modules": true,
|
"packages/*/node_modules": true
|
||||||
},
|
},
|
||||||
"markdownlint.config": {
|
"markdownlint.config": {
|
||||||
// "comment": "Relaxed rules",
|
// "comment": "Relaxed rules",
|
||||||
@@ -32,6 +33,10 @@
|
|||||||
"first-line-h1": false,
|
"first-line-h1": false,
|
||||||
"block-spacing": false,
|
"block-spacing": false,
|
||||||
"blanks-around-lists": false,
|
"blanks-around-lists": false,
|
||||||
"ol-prefix": false
|
"ol-prefix": false,
|
||||||
}
|
"no-duplicate-heading": false
|
||||||
|
},
|
||||||
|
"js/ts.tsdk.path": "node_modules/typescript/lib",
|
||||||
|
"typescript.tsdk": "node_modules/typescript/lib",
|
||||||
|
"typescript.enablePromptUseWorkspaceTsdk": true
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
This is a **monorepo** with npm workspaces:
|
This is a **monorepo** with npm workspaces:
|
||||||
|
|
||||||
- **Page Agent** (`packages/page-agent/`) - Main entry with built-in UI Panel, published as `page-agent` on npm
|
- **Page Agent** (`packages/page-agent/`) - Main entry with built-in UI Panel, published as `page-agent` on npm
|
||||||
- **Extension** (`packages/extension/`) - Browser extension (WXT + React) 🚧 WIP
|
- **Extension** (`packages/extension/`) - Browser extension (WXT + React)
|
||||||
- **Website** (`packages/website/`) - React docs and landing page. **When working on website, follow `packages/website/AGENTS.md`**
|
- **Website** (`packages/website/`) - React docs and landing page. **When working on website, follow `packages/website/AGENTS.md`**
|
||||||
|
|
||||||
Internal packages:
|
Internal packages:
|
||||||
@@ -18,17 +18,19 @@ Internal packages:
|
|||||||
## Development Commands
|
## Development Commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm start # Start website dev server
|
npm start # Start website dev server
|
||||||
npm run build # Build all packages
|
npm run build # Build all packages
|
||||||
npm run build:libs # Build all libraries
|
npm run build:libs # Build all libraries
|
||||||
npm run lint # ESLint with TypeScript strict rules
|
npm run typecheck # Typecheck all packages (libs + website + extension)
|
||||||
|
npm run lint # ESLint
|
||||||
|
npm run zip -w @page-agent/ext # Zip the extension package
|
||||||
```
|
```
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
### Monorepo Structure
|
### Monorepo Structure
|
||||||
|
|
||||||
Simple monorepo solution: TypeScript references + Vite aliases. Update tsconfig and vite config when adding/removing packages.
|
Source-first monorepo: library `package.json` exports point to `src/*.ts` during development. At publish time, `scripts/pre-publish.js` promotes `publishConfig` fields to top-level (swapping to `dist/`), and `scripts/post-publish.js` restores the originals.
|
||||||
|
|
||||||
```
|
```
|
||||||
packages/
|
packages/
|
||||||
@@ -36,7 +38,7 @@ packages/
|
|||||||
├── page-agent/ # npm: "page-agent" entry class (with UI + controller + demo builds)
|
├── page-agent/ # npm: "page-agent" entry class (with UI + controller + demo builds)
|
||||||
├── website/ # @page-agent/website (private)
|
├── website/ # @page-agent/website (private)
|
||||||
├── llms/ # @page-agent/llms
|
├── llms/ # @page-agent/llms
|
||||||
├── extension/ # 🚧 WIP: Browser extension (WXT + React)
|
├── extension/ # Browser extension (WXT + React)
|
||||||
├── page-controller/ # @page-agent/page-controller
|
├── page-controller/ # @page-agent/page-controller
|
||||||
└── ui/ # @page-agent/ui
|
└── ui/ # @page-agent/ui
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,94 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
|
||||||
|
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
||||||
|
|
||||||
## [1.0.0] - 2026-01-19
|
|
||||||
|
|
||||||
### 🎉 First Stable Release
|
|
||||||
|
|
||||||
PageAgent is now ready for production use. The API is stable and breaking changes will follow semantic versioning.
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
#### Core
|
|
||||||
|
|
||||||
- **PageAgent** - Main entry class with built-in UI Panel
|
|
||||||
- **PageAgentCore** - Headless agent class for custom UI or programmatic use
|
|
||||||
- **DOM Analysis** - Text-based DOM extraction with high-intensity dehydration
|
|
||||||
- **LLM Support** - Works with OpenAI, Claude, DeepSeek, Qwen, and other OpenAI-compatible APIs
|
|
||||||
- **Tool System** - Built-in tools for click, input, scroll, select, and more
|
|
||||||
- **Custom Tools** - Extend agent capabilities with your own tools (experimental)
|
|
||||||
- **Lifecycle Hooks** - Hook into agent execution (experimental)
|
|
||||||
- **Instructions System** - System-level and page-level instructions to guide agent behavior
|
|
||||||
- **Data Masking** - Transform page content before sending to LLM
|
|
||||||
|
|
||||||
#### Page Controller
|
|
||||||
|
|
||||||
- **Element Interactions** - Click, input text, select options, scroll
|
|
||||||
- **Visual Mask** - Blocks user interaction during automation
|
|
||||||
- **DOM Tree Extraction** - Efficient page structure extraction for LLM consumption
|
|
||||||
|
|
||||||
#### UI
|
|
||||||
|
|
||||||
- **Interactive Panel** - Real-time task progress and agent thinking display
|
|
||||||
- **Ask User Tool** - Agent can ask users for clarification
|
|
||||||
- **i18n Support** - English and Chinese localization
|
|
||||||
|
|
||||||
### Configuration
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
interface PageAgentConfig {
|
|
||||||
// LLM Configuration (required)
|
|
||||||
baseURL: string
|
|
||||||
apiKey: string
|
|
||||||
model: string
|
|
||||||
temperature?: number
|
|
||||||
maxRetries?: number
|
|
||||||
customFetch?: typeof fetch
|
|
||||||
|
|
||||||
// Agent Configuration
|
|
||||||
language?: 'en-US' | 'zh-CN'
|
|
||||||
maxSteps?: number // default: 20
|
|
||||||
customTools?: Record<string, PageAgentTool> // experimental
|
|
||||||
instructions?: InstructionsConfig
|
|
||||||
transformPageContent?: (content: string) => string | Promise<string>
|
|
||||||
experimentalScriptExecutionTool?: boolean // default: false
|
|
||||||
|
|
||||||
// Lifecycle Hooks (experimental)
|
|
||||||
onBeforeTask?: (agent, result) => void
|
|
||||||
onAfterTask?: (agent, result) => void
|
|
||||||
onBeforeStep?: (agent, stepCount) => void
|
|
||||||
onAfterStep?: (agent, history) => void
|
|
||||||
onDispose?: (agent, reason?) => void
|
|
||||||
|
|
||||||
// Page Controller Configuration
|
|
||||||
enableMask?: boolean // default: true
|
|
||||||
viewportExpansion?: number
|
|
||||||
interactiveBlacklist?: Element[]
|
|
||||||
interactiveWhitelist?: Element[]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Packages
|
|
||||||
|
|
||||||
| Package | Description |
|
|
||||||
| ----------------------------- | ---------------------------------- |
|
|
||||||
| `page-agent` | Main entry with UI Panel |
|
|
||||||
| `@page-agent/core` | Core agent logic without UI |
|
|
||||||
| `@page-agent/llms` | LLM client with retry logic |
|
|
||||||
| `@page-agent/page-controller` | DOM operations and visual feedback |
|
|
||||||
| `@page-agent/ui` | Panel and i18n |
|
|
||||||
|
|
||||||
### Known Limitations
|
|
||||||
|
|
||||||
- Single-page application only (cannot navigate across pages)
|
|
||||||
- No visual recognition (relies on DOM structure)
|
|
||||||
- Limited interaction support (no hover, drag-drop, canvas operations)
|
|
||||||
- See [Limitations](https://alibaba.github.io/page-agent/#/docs/introduction/limitations) for details
|
|
||||||
|
|
||||||
### Acknowledgments
|
|
||||||
|
|
||||||
This project builds upon the excellent work of [browser-use](https://github.com/browser-use/browser-use). DOM processing components and prompts are adapted from browser-use (MIT License).
|
|
||||||
+22
-185
@@ -1,40 +1,14 @@
|
|||||||
# Contributing to Page-Agent
|
# Contributing to PageAgent
|
||||||
|
|
||||||
Thank you for your interest in contributing to Page-Agent! We welcome contributions from everyone.
|
♥️ We welcome contributions from everyone.
|
||||||
|
|
||||||
## 🚀 Quick Start
|
For local development workflows, setup, local LLM config, extension development, testing on other websites, and more details, see [docs/developer-guide.md](docs/developer-guide.md).
|
||||||
|
|
||||||
### Development Setup
|
|
||||||
|
|
||||||
1. **Prerequisites**
|
|
||||||
- `node.js >= 20` with `npm >= 10`
|
|
||||||
- An editor that supports `ts/eslint/prettier`
|
|
||||||
- Make sure `eslint`, `prettier` and `commitlint` work well
|
|
||||||
|
|
||||||
2. **Setup**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm ci
|
|
||||||
npm start # Start demo and documentation site
|
|
||||||
```
|
|
||||||
|
|
||||||
### Project Structure
|
|
||||||
|
|
||||||
This is a **monorepo** with npm workspaces containing **3 main packages**:
|
|
||||||
|
|
||||||
- **Page Agent** (`packages/page-agent/`) - Main entry with built-in UI Panel, published as `page-agent` on npm
|
|
||||||
- **Core** (`packages/core/`) - Core agent logic without UI (npm: `@page-agent/core`)
|
|
||||||
- **Website** (`packages/website/`) - React documentation and landing page. Also as demo and test page for the core lib. private package `@page-agent/website`
|
|
||||||
|
|
||||||
We use a simplified monorepo solution with `native npm-workspace + ts reference + vite alias`. No fancy tooling. Hoisting is required.
|
|
||||||
|
|
||||||
- When developing. Use alias so that we don't have to pre-build.
|
|
||||||
- When bundling. Use external and disable ts `paths` alias to leave deps out.
|
|
||||||
- When bundling `IIFE` and `Website`. Bundle everything including local packages.
|
|
||||||
|
|
||||||
## 🤝 How to Contribute
|
## 🤝 How to Contribute
|
||||||
|
|
||||||
### Reporting Issues
|
> **[Maintainer's Note](https://github.com/alibaba/page-agent/issues/349)**
|
||||||
|
|
||||||
|
### Opening Issues
|
||||||
|
|
||||||
- Use the GitHub issue tracker to report bugs or request features
|
- Use the GitHub issue tracker to report bugs or request features
|
||||||
- Search existing issues before creating new ones
|
- Search existing issues before creating new ones
|
||||||
@@ -43,168 +17,31 @@ We use a simplified monorepo solution with `native npm-workspace + ts reference
|
|||||||
|
|
||||||
### Code Contributions
|
### Code Contributions
|
||||||
|
|
||||||
1. **Fork and Clone**
|
1. Follow existing code style and patterns
|
||||||
|
2. Update documentation as needed
|
||||||
|
3. Add JSDoc for public APIs
|
||||||
|
4. Build and lint everything
|
||||||
|
5. Test in our demo website, and on other websites if applicable
|
||||||
|
6. Include screenshots for UI changes
|
||||||
|
|
||||||
```bash
|
### Vibe Coding with AI
|
||||||
git clone https://github.com/your-username/page-agent.git
|
|
||||||
cd page-agent
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Create Feature Branch**
|
- Vibe coding is **NOT** allowed for the core lib or the extension!!!
|
||||||
|
- Vibe coding is **RECOMMENDED** when maintaining **the demo, the website, the UI and tests**.
|
||||||
```bash
|
- Make sure your AI references `AGENTS.md` and `website/AGENTS.md` for better quality.
|
||||||
git checkout -b feat/your-feature-name
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Make Changes**
|
|
||||||
- Follow existing code style and patterns
|
|
||||||
- Add tests for new functionality
|
|
||||||
- Update documentation as needed
|
|
||||||
|
|
||||||
4. **Test Your Changes**
|
|
||||||
- Test in our demo website
|
|
||||||
- Test it on other websites if applicable
|
|
||||||
- `@TODO: test suite`
|
|
||||||
|
|
||||||
5. **Commit and Push**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git add .
|
|
||||||
git commit -m "feat: add awesome feature"
|
|
||||||
git push origin feat/your-feature-name
|
|
||||||
```
|
|
||||||
|
|
||||||
6. **Create Pull Request**
|
|
||||||
- Provide clear description of changes
|
|
||||||
- Link related issues
|
|
||||||
- Include screenshots for UI changes
|
|
||||||
|
|
||||||
## 📝 Code Style
|
|
||||||
|
|
||||||
### General Guidelines
|
|
||||||
|
|
||||||
- Use TypeScript for type safety
|
|
||||||
- Follow existing naming conventions
|
|
||||||
- Write meaningful commit messages
|
|
||||||
- Keep functions small and focused
|
|
||||||
- Add JSDoc for public APIs
|
|
||||||
|
|
||||||
### Vibe coding with AI
|
|
||||||
|
|
||||||
- It's **recommended** to heavily rely on AI (aka "vibe coding") when maintaining **demo pages and tests**.
|
|
||||||
- Be very careful if AI ever touched the core lib!!!
|
|
||||||
- Review anything AI wrote before make a commit. You are the author of anything you commit. NOT AI.
|
- Review anything AI wrote before make a commit. You are the author of anything you commit. NOT AI.
|
||||||
- Update the [AI instructions](AGENTS.md) when structure changed.
|
|
||||||
|
|
||||||
If your lame AI assistant does not support [AGENTS.md](https://agents.md/). Add an alias for it:
|
|
||||||
|
|
||||||
- claude-code (`CLAUDE.md`)
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
@AGENTS.md
|
|
||||||
```
|
|
||||||
|
|
||||||
- antigravity (`.agent/rules/alias.md`)
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
---
|
|
||||||
trigger: always_on
|
|
||||||
---
|
|
||||||
|
|
||||||
@../../AGENTS.md
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🔧 Development Workflows
|
|
||||||
|
|
||||||
### Test With Your Own LLM API
|
|
||||||
|
|
||||||
- Create a `.env` file in the repo root with your LLM API config
|
|
||||||
|
|
||||||
```env
|
|
||||||
LLM_MODEL_NAME=gpt-5.2
|
|
||||||
LLM_API_KEY=your-api-key
|
|
||||||
LLM_BASE_URL=https://api.your-llm-provider.com/v1
|
|
||||||
```
|
|
||||||
|
|
||||||
- **Ollama example** (tested on 0.15 + qwen3:14b, RTX3090 24GB):
|
|
||||||
|
|
||||||
```env
|
|
||||||
LLM_BASE_URL="http://localhost:11434/v1"
|
|
||||||
LLM_API_KEY="NA"
|
|
||||||
LLM_MODEL_NAME="qwen3:14b"
|
|
||||||
```
|
|
||||||
|
|
||||||
> ⚠️ Add `*` to `OLLAMA_ORIGINS` (403). Models < 10B unlikely strong enough. Requires tool_call support. Set context length > 15k (default 4k will NOT work): `$env:OLLAMA_CONTEXT_LENGTH=64000; ollama serve`
|
|
||||||
|
|
||||||
- Restart the dev server to load new env vars
|
|
||||||
- If not provided, the demo will the free testing proxy by default
|
|
||||||
|
|
||||||
### Website Development
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
### Testing on Other Websites
|
|
||||||
|
|
||||||
- Start and serve a local `iife` script
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run dev:demo # Serving IIFE with auto rebuild at http://localhost:5174/page-agent.demo.js
|
|
||||||
```
|
|
||||||
|
|
||||||
- Add a new bookmark
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
javascript:(function(){var s=document.createElement('script');s.src=`http://localhost:5174/page-agent.demo.js?t=${Math.random()}`;s.onload=()=>console.log(%27PageAgent ready!%27);document.head.appendChild(s);})();
|
|
||||||
```
|
|
||||||
|
|
||||||
- Click the bookmark on any page to load Page-Agent
|
|
||||||
|
|
||||||
> Warning: AK in your local `.env` will be inlined in the iife script.
|
|
||||||
|
|
||||||
### Adding Documentation
|
|
||||||
|
|
||||||
Ask an AI to help you add documentation to the `website/` package. Follow the existing style.
|
|
||||||
|
|
||||||
> Our AGENTS.md file and guardrails are designed for this purpose. But please be careful and review anything AI generated.
|
|
||||||
|
|
||||||
## 🎯 Contribution Areas
|
|
||||||
|
|
||||||
We especially welcome contributions in:
|
|
||||||
|
|
||||||
- **Browser compatibility** improvements
|
|
||||||
- **Performance optimizations** for DOM processing
|
|
||||||
- **Documentation** and examples
|
|
||||||
- **Testing** and quality assurance
|
|
||||||
- **Accessibility** features
|
|
||||||
- **Internationalization** support
|
|
||||||
|
|
||||||
## 🚫 What We Don't Accept
|
## 🚫 What We Don't Accept
|
||||||
|
|
||||||
- Changes that break existing API compatibility (Discuss first)
|
- Breaking changes and large PRs without prior discussion
|
||||||
- Heavy dependencies to core library
|
- Heavy dependencies to core libs
|
||||||
- Contributions without proper testing
|
- Dependencies or code with licenses incompatible with MIT
|
||||||
- Code that doesn't follow project conventions
|
- Bot or AI-generated pull requests without meaningful human involvement
|
||||||
|
|
||||||
## 📄 Legal
|
## 📄 Legal
|
||||||
|
|
||||||
By contributing to this project, you agree that your contributions will be licensed under the MIT License.
|
By contributing to this project, you agree that your contributions will be licensed under the MIT License.
|
||||||
|
|
||||||
> You may need to sign a github CLA before you create a PR.
|
---
|
||||||
|
|
||||||
### Browser-Use Attribution
|
Thank you for helping make PageAgent better! 🎉
|
||||||
|
|
||||||
Parts of this project are derived from the [browser-use](https://github.com/browser-use/browser-use) project (MIT License). When contributing to DOM-related functionality:
|
|
||||||
|
|
||||||
- Maintain existing attribution comments
|
|
||||||
- Follow similar patterns for consistency
|
|
||||||
- Credit browser-use for derived concepts
|
|
||||||
|
|
||||||
## 💬 Questions?
|
|
||||||
|
|
||||||
- Open a GitHub issue for technical questions
|
|
||||||
- Check existing documentation and issues first
|
|
||||||
- Be respectful and constructive in discussions
|
|
||||||
|
|
||||||
Thank you for helping make Page-Agent better! 🎉
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2026 Alibaba
|
Copyright (c) 2026 SimonLuvRamen
|
||||||
Copyright (c) 2026 Simon
|
Copyright (c) 2026 Alibaba Group Holding Limited
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
-126
@@ -1,126 +0,0 @@
|
|||||||
# PageAgent 🤖🪄
|
|
||||||
|
|
||||||
<picture>
|
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="https://img.alicdn.com/imgextra/i4/O1CN01qKig1P1FnhpFKNdi6_!!6000000000532-2-tps-1280-256.png">
|
|
||||||
<img alt="Page Agent Banner" src="https://img.alicdn.com/imgextra/i1/O1CN01NCMKXj1Gn4tkFTsxf_!!6000000000666-2-tps-1280-256.png">
|
|
||||||
</picture>
|
|
||||||
|
|
||||||
[](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [](https://www.npmjs.com/package/page-agent) [](https://bundlephobia.com/package/page-agent) [](https://github.com/alibaba/page-agent)
|
|
||||||
|
|
||||||
纯 JS 实现的 GUI agent。使用自然语言操作你的 Web 应用。无须后端、客户端、浏览器插件。
|
|
||||||
|
|
||||||
🌐 [English](./README.md) | **中文**
|
|
||||||
|
|
||||||
👉 <a href="https://alibaba.github.io/page-agent/" target="_blank"><b>🚀 Demo</b></a> | <a href="https://alibaba.github.io/page-agent/#/docs/introduction/overview" target="_blank"><b>📖 Documentation</b></a>
|
|
||||||
|
|
||||||
<video id="demo-video" src="https://github.com/user-attachments/assets/34d8444d-cbfb-44a3-a24e-fd5c167bb0bf" controls crossorigin muted></video>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## ✨ Features
|
|
||||||
|
|
||||||
- **🎯 轻松集成**
|
|
||||||
- 无需 Python,无需无头浏览器,无需浏览器插件。纯页面内脚本。
|
|
||||||
- **🔐 端侧运行**
|
|
||||||
- **🧠 HTML 脱水**
|
|
||||||
- **💬 自然语言接口**
|
|
||||||
- **🎨 HITL 交互界面**
|
|
||||||
|
|
||||||
以及 😉
|
|
||||||
|
|
||||||
- **🧪 实验性的 Chrome 扩展,支持跨页面控制** - `packages/extension`
|
|
||||||
|
|
||||||
👉 [**🗺️ Roadmap**](https://github.com/alibaba/page-agent/issues/96)
|
|
||||||
|
|
||||||
## 🚀 快速开始
|
|
||||||
|
|
||||||
### 一行代码集成
|
|
||||||
|
|
||||||
通过我们免费的 Demo LLM 快速体验 PageAgent:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script
|
|
||||||
src="https://registry.npmmirror.com/page-agent/1.1.0/files/dist/iife/page-agent.demo.js"
|
|
||||||
crossorigin="true"
|
|
||||||
></script>
|
|
||||||
```
|
|
||||||
|
|
||||||
> - **⚠️ 仅用于技术评估。** Demo LLM 有速率和使用限制,可能随时变更。
|
|
||||||
> - **🌷 建议使用自己的 LLM API。**
|
|
||||||
|
|
||||||
| Mirrors | URL |
|
|
||||||
| ------- | ---------------------------------------------------------------------------------- |
|
|
||||||
| Global | https://cdn.jsdelivr.net/npm/page-agent@1.1.0/dist/iife/page-agent.demo.js |
|
|
||||||
| China | https://registry.npmmirror.com/page-agent/1.1.0/files/dist/iife/page-agent.demo.js |
|
|
||||||
|
|
||||||
### NPM 安装
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install page-agent
|
|
||||||
```
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import { PageAgent } from 'page-agent'
|
|
||||||
|
|
||||||
const agent = new PageAgent({
|
|
||||||
model: 'deepseek-chat',
|
|
||||||
baseURL: 'https://api.deepseek.com',
|
|
||||||
apiKey: 'YOUR_API_KEY',
|
|
||||||
language: 'zh-CN',
|
|
||||||
})
|
|
||||||
|
|
||||||
await agent.execute('点击登录按钮')
|
|
||||||
```
|
|
||||||
|
|
||||||
适用于无法使用 NPM 的环境,我们也提供了 IIFE 构建的 CDN 方式。[@see CDN Usage](https://alibaba.github.io/page-agent/#/docs/integration/cdn-setup)
|
|
||||||
|
|
||||||
## 🏗️ 架构设计
|
|
||||||
|
|
||||||
PageAgent adopts a simplified monorepo structure:
|
|
||||||
|
|
||||||
```
|
|
||||||
packages/
|
|
||||||
├── core/ # ** Core agent logic without UI(npm: @page-agent/core) **
|
|
||||||
├── page-agent/ # Exported agent and demo(npm: page-agent)
|
|
||||||
├── llms/ # LLM 客户端 (npm: @page-agent/llms)
|
|
||||||
├── page-controller/ # DOM 操作 & 蒙层 & 模拟鼠标 (npm: @page-agent/page-controller)
|
|
||||||
├── ui/ # 面板 & i18n (npm: @page-agent/ui)
|
|
||||||
└── website/ # 文档站点
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🤝 贡献
|
|
||||||
|
|
||||||
欢迎社区贡献!请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 了解环境配置和本地开发说明。
|
|
||||||
|
|
||||||
请在贡献前阅读[行为准则](CODE_OF_CONDUCT.md)。
|
|
||||||
|
|
||||||
## 👏 致谢
|
|
||||||
|
|
||||||
本项目基于 **[`browser-use`](https://github.com/browser-use/browser-use)** 的优秀工作构建。
|
|
||||||
|
|
||||||
`PageAgent` 专为**客户端网页增强**设计,不是服务端自动化工具。
|
|
||||||
|
|
||||||
```
|
|
||||||
DOM processing components and prompt are derived from browser-use:
|
|
||||||
|
|
||||||
Browser Use
|
|
||||||
Copyright (c) 2024 Gregor Zunic
|
|
||||||
Licensed under the MIT License
|
|
||||||
|
|
||||||
Original browser-use project: <https://github.com/browser-use/browser-use>
|
|
||||||
|
|
||||||
We gratefully acknowledge the browser-use project and its contributors for their
|
|
||||||
excellent work on web automation and DOM interaction patterns that helped make
|
|
||||||
this project possible.
|
|
||||||
|
|
||||||
Third-party dependencies and their licenses can be found in the package.json
|
|
||||||
file and in the node_modules directory after installation.
|
|
||||||
```
|
|
||||||
|
|
||||||
## 📄 许可证
|
|
||||||
|
|
||||||
[MIT License](LICENSE)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**⭐ 如果觉得 PageAgent 有用或有趣,请给项目点个星!**
|
|
||||||
@@ -1,36 +1,40 @@
|
|||||||
# PageAgent 🤖🪄
|
# Page Agent
|
||||||
|
|
||||||
<picture>
|
<picture>
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="https://img.alicdn.com/imgextra/i4/O1CN01qKig1P1FnhpFKNdi6_!!6000000000532-2-tps-1280-256.png">
|
<source media="(prefers-color-scheme: dark)" srcset="https://img.alicdn.com/imgextra/i4/O1CN01qKig1P1FnhpFKNdi6_!!6000000000532-2-tps-1280-256.png">
|
||||||
<img alt="Page Agent Banner" src="https://img.alicdn.com/imgextra/i1/O1CN01NCMKXj1Gn4tkFTsxf_!!6000000000666-2-tps-1280-256.png">
|
<img alt="Page Agent Banner" src="https://img.alicdn.com/imgextra/i1/O1CN01NCMKXj1Gn4tkFTsxf_!!6000000000666-2-tps-1280-256.png">
|
||||||
</picture>
|
</picture>
|
||||||
|
|
||||||
[](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [](https://www.npmjs.com/package/page-agent) [](https://bundlephobia.com/package/page-agent) [](https://github.com/alibaba/page-agent)
|
[](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [](https://bundlephobia.com/package/page-agent) [](https://www.npmjs.com/package/page-agent) [](https://github.com/alibaba/page-agent)
|
||||||
|
|
||||||
The GUI Agent Living in Your Webpage. Control web interfaces with natural language.
|
The GUI Agent Living in Your Webpage. Control web interfaces with natural language.
|
||||||
|
|
||||||
🌐 **English** | [中文](./README-zh.md)
|
🌐 **English** | [中文](./docs/README-zh.md)
|
||||||
|
|
||||||
👉 <a href="https://alibaba.github.io/page-agent/" target="_blank"><b>🚀 Demo</b></a> | <a href="https://alibaba.github.io/page-agent/#/docs/introduction/overview" target="_blank"><b>📖 Documentation</b></a>
|
<a href="https://alibaba.github.io/page-agent/" target="_blank"><b>🚀 Demo</b></a> | <a href="https://alibaba.github.io/page-agent/docs/introduction/overview" target="_blank"><b>📖 Docs</b></a> | <a href="https://news.ycombinator.com/item?id=47264138" target="_blank"><b>📢 HN Discussion</b></a> | <a href="https://x.com/simonluvramen" target="_blank"><b>𝕏 Follow on X</b></a>
|
||||||
|
|
||||||
<video id="demo-video" src="https://github.com/user-attachments/assets/34d8444d-cbfb-44a3-a24e-fd5c167bb0bf" controls crossorigin muted></video>
|
<video id="demo-video" src="https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2" controls crossorigin muted></video>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ✨ Features
|
## ✨ Features
|
||||||
|
|
||||||
- **🎯 Easy Integration**
|
- **🎯 Easy integration**
|
||||||
- No python. No headless browser. No browser extension. Just in-page scripts.
|
- No need for `browser extension` / `python` / `headless browser`.
|
||||||
- **🔐 Client-Side Processing**
|
- Just in-page javascript. Everything happens in your web page.
|
||||||
- **🧠 DOM Extraction**
|
- **📖 Text-based DOM manipulation**
|
||||||
- **💬 Natural Language Interface**
|
- No screenshots. No multi-modal LLMs or special permissions needed.
|
||||||
- **🎨 UI with Human in the loop**
|
- **🧠 Bring your own LLMs**
|
||||||
|
- **🐙 Optional [chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension) for multi-page tasks.**
|
||||||
|
- And an [MCP Server (Beta)](https://alibaba.github.io/page-agent/docs/features/mcp-server) to control it from outside
|
||||||
|
|
||||||
And 😉
|
## 💡 Use Cases
|
||||||
|
|
||||||
- **🧪 `cross-page` control with an experimental chrome extension** - `packages/extension`
|
- **SaaS AI Copilot** — Ship an AI copilot in your product in lines of code. No backend rewrite.
|
||||||
|
- **Smart Form Filling** — Turn 20-click workflows into one sentence. Perfect for ERP, CRM, and admin systems.
|
||||||
👉 [**🗺️ Roadmap**](https://github.com/alibaba/page-agent/issues/96)
|
- **Accessibility** — Make any web app accessible through natural language. Voice commands, screen readers, zero barrier.
|
||||||
|
- **Multi-page Agent** — Extend your own web agent's reach across browser tabs [chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension).
|
||||||
|
- **MCP** - Allow your agent clients to control your browser.
|
||||||
|
|
||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
@@ -39,19 +43,15 @@ And 😉
|
|||||||
Fastest way to try PageAgent with our free Demo LLM:
|
Fastest way to try PageAgent with our free Demo LLM:
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<script
|
<script src="{URL}" crossorigin="true"></script>
|
||||||
src="https://cdn.jsdelivr.net/npm/page-agent@1.1.0/dist/iife/page-agent.demo.js"
|
|
||||||
crossorigin="true"
|
|
||||||
></script>
|
|
||||||
```
|
```
|
||||||
|
|
||||||
> - **⚠️ For technical evaluation only.** Demo LLM has rate limits and usage restrictions. May change without notice.
|
> **⚠️ For technical evaluation only.** This demo CDN uses our free [testing LLM API](https://alibaba.github.io/page-agent/docs/features/models#free-testing-api). By using it, you agree to its [terms](https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md).
|
||||||
> - **🌷 Bring your own LLM API.**
|
|
||||||
|
|
||||||
| Mirrors | URL |
|
| Mirrors | URL |
|
||||||
| ------- | ---------------------------------------------------------------------------------- |
|
| ------- | ---------------------------------------------------------------------------------- |
|
||||||
| Global | https://cdn.jsdelivr.net/npm/page-agent@1.1.0/dist/iife/page-agent.demo.js |
|
| Global | https://cdn.jsdelivr.net/npm/page-agent@1.8.0/dist/iife/page-agent.demo.js |
|
||||||
| China | https://registry.npmmirror.com/page-agent/1.1.0/files/dist/iife/page-agent.demo.js |
|
| China | https://registry.npmmirror.com/page-agent/1.8.0/files/dist/iife/page-agent.demo.js |
|
||||||
|
|
||||||
### NPM Installation
|
### NPM Installation
|
||||||
|
|
||||||
@@ -63,8 +63,8 @@ npm install page-agent
|
|||||||
import { PageAgent } from 'page-agent'
|
import { PageAgent } from 'page-agent'
|
||||||
|
|
||||||
const agent = new PageAgent({
|
const agent = new PageAgent({
|
||||||
model: 'deepseek-chat',
|
model: 'qwen3.5-plus',
|
||||||
baseURL: 'https://api.deepseek.com',
|
baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1',
|
||||||
apiKey: 'YOUR_API_KEY',
|
apiKey: 'YOUR_API_KEY',
|
||||||
language: 'en-US',
|
language: 'en-US',
|
||||||
})
|
})
|
||||||
@@ -72,25 +72,29 @@ const agent = new PageAgent({
|
|||||||
await agent.execute('Click the login button')
|
await agent.execute('Click the login button')
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🏗️ Structure
|
For more programmatic usage, see [📖 Documentations](https://alibaba.github.io/page-agent/docs/introduction/overview).
|
||||||
|
|
||||||
PageAgent adopts a simplified monorepo structure:
|
## 🌟 Awesome Page Agent
|
||||||
|
|
||||||
```
|
Built something cool with PageAgent? Add it here! Open a PR to share your project.
|
||||||
packages/
|
|
||||||
├── core/ # ** Core agent logic without UI(npm: @page-agent/core) **
|
> These are community projects — not maintained or endorsed by us. Use at your own discretion.
|
||||||
├── page-agent/ # Exported agent and demo(npm: page-agent)
|
|
||||||
├── llms/ # LLM client (npm: @page-agent/llms)
|
| Project | Description |
|
||||||
├── page-controller/ # DOM operations & Visual Mask (npm: @page-agent/page-controller)
|
| -------- | ----------------------------------------------------------- |
|
||||||
├── ui/ # Panel & i18n (npm: @page-agent/ui)
|
| _Yours?_ | [Open a PR](https://github.com/alibaba/page-agent/pulls) 🙌 |
|
||||||
└── website/ # Demo & Documentation site
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🤝 Contributing
|
## 🤝 Contributing
|
||||||
|
|
||||||
We welcome contributions from the community! Follow our instructions in [CONTRIBUTING.md](CONTRIBUTING.md) for environment setup and local development.
|
We welcome contributions from the community! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and [docs/developer-guide.md](docs/developer-guide.md) for local development workflows.
|
||||||
|
|
||||||
Please read [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
|
Please read the [maintainer's note](https://github.com/alibaba/page-agent/issues/349) on principles and current state.
|
||||||
|
|
||||||
|
Contributions generated entirely by **bots or AI** without substantial human involvement will **not be accepted**.
|
||||||
|
|
||||||
|
## ⚖️ License
|
||||||
|
|
||||||
|
[MIT License](LICENSE)
|
||||||
|
|
||||||
## 👏 Acknowledgments
|
## 👏 Acknowledgments
|
||||||
|
|
||||||
@@ -101,24 +105,15 @@ This project builds upon the excellent work of **[`browser-use`](https://github.
|
|||||||
```
|
```
|
||||||
DOM processing components and prompt are derived from browser-use:
|
DOM processing components and prompt are derived from browser-use:
|
||||||
|
|
||||||
Browser Use
|
Browser Use <https://github.com/browser-use/browser-use>
|
||||||
Copyright (c) 2024 Gregor Zunic
|
Copyright (c) 2024 Gregor Zunic
|
||||||
Licensed under the MIT License
|
Licensed under the MIT License
|
||||||
|
|
||||||
Original browser-use project: <https://github.com/browser-use/browser-use>
|
|
||||||
|
|
||||||
We gratefully acknowledge the browser-use project and its contributors for their
|
We gratefully acknowledge the browser-use project and its contributors for their
|
||||||
excellent work on web automation and DOM interaction patterns that helped make
|
excellent work on web automation and DOM interaction patterns that helped make
|
||||||
this project possible.
|
this project possible.
|
||||||
|
|
||||||
Third-party dependencies and their licenses can be found in the package.json
|
|
||||||
file and in the node_modules directory after installation.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 📄 License
|
|
||||||
|
|
||||||
[MIT License](LICENSE)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**⭐ Star this repo if you find PageAgent helpful!**
|
**⭐ Star this repo if you find PageAgent helpful!**
|
||||||
|
|||||||
@@ -0,0 +1,250 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||||
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [1.7.1] - 2026-04-04
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- **Optional `keepSemanticTags`** - Added an experimental `keepSemanticTags` config to preserve semantic structure in PageController output
|
||||||
|
- **Per-task extension system instructions** - Extension `ExecuteConfig` now supports `systemInstruction`
|
||||||
|
|
||||||
|
### Improvements
|
||||||
|
|
||||||
|
- **Smarter scroll handling** - Scroll container detection and scroll direction handling are more reliable
|
||||||
|
- **Better accessibility-aware element detection** - Interactive candidates with supported ARIA attributes and `role="listitem"` are recognized more accurately
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Fixed iframe-origin filtering for extension `postMessage` listeners
|
||||||
|
- Avoided a `currentScript` null pointer during deferred initialization
|
||||||
|
|
||||||
|
## [1.7.0] - 2026-03-31
|
||||||
|
|
||||||
|
- **More reliable click actions** - Click handling now reuses pointer coordinates, verifies targets with `elementFromPoint`, and behaves better on layered layouts
|
||||||
|
- **Better mask event handling** - `SimulatorMask` now supports passthrough events when automation should not fully swallow input
|
||||||
|
- Fixed a `SimulatorMask` memory leak
|
||||||
|
|
||||||
|
## [1.6.3] - 2026-03-30
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- **Experimental all-tabs control** - Extension can include and control all browser tabs via `experimentalIncludeAllTabs`
|
||||||
|
|
||||||
|
### Improvements
|
||||||
|
|
||||||
|
- **Calmer empty state motion** - Disabled the EmptyState auto-start animation in the extension UI
|
||||||
|
- **Cleaner extension docs** - Simplified setup and tab-control documentation across the README and developer guide
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Fixed new-tab detection from content scripts
|
||||||
|
- Fixed tab deduplication and multi-window handling in the extension
|
||||||
|
|
||||||
|
## [1.6.2] - 2026-03-25
|
||||||
|
|
||||||
|
- **Longer task input** - The UI task input now accepts up to 1000 characters
|
||||||
|
- **Contributor docs refresh** - Added a maintainer note and refreshed contributor-facing documentation
|
||||||
|
- Fixed lint issues in the release pipeline
|
||||||
|
|
||||||
|
## [1.6.1] - 2026-03-22
|
||||||
|
|
||||||
|
- **Internal PageController action exports** - PageController actions are now exposed as internal methods for easier reuse across packages
|
||||||
|
- **Expanded docs** - Added MCP docs and clarified project limitations and homepage details
|
||||||
|
|
||||||
|
## [1.6.0] - 2026-03-21
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- **Beta MCP support** - New `@page-agent/mcp` package lets MCP clients such as Claude Desktop and Copilot control the browser through the Page Agent extension
|
||||||
|
- **Better iframe handling** - Same-origin iframe elements are handled more reliably during DOM extraction and actions
|
||||||
|
- **Extension history workflows** - Users can rerun past tasks, export history sessions as JSON, and approve MCP-triggered tasks before execution
|
||||||
|
|
||||||
|
### Improvements
|
||||||
|
|
||||||
|
- **Unified versioning across packages** - The extension now follows the root workspace version. Changelog entries are no longer split into a separate extension version section
|
||||||
|
- **Configurable `stepDelay`** - Agent pacing between steps is now configurable via `stepDelay`
|
||||||
|
- **Optional API key** - `apiKey` can now be omitted for compatible deployments that do not require one
|
||||||
|
- **Optional named tool choice** - Tool invocation can disable named tool choice for providers that behave better without it
|
||||||
|
- **Better rich-text input support** - Improved `contenteditable` handling with better event dispatching and `execCommand` fallback for more editors
|
||||||
|
- **More flexible DOM extraction** - `includeAttributes` now supports wildcards, `contenteditable` is included by default, and heuristically interactive elements expose more useful attributes
|
||||||
|
- **MiniMax model support** - Added MiniMax compatibility, with the default recommendation updated to `MiniMax-M2.7`
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Fixed Safari issues when `requestIdleCallback` is unavailable
|
||||||
|
- Avoid throwing when `webgl2` initialization fails
|
||||||
|
- Improved OpenAI-compatible request patches for GPT-5.4 chat tools and MiniMax temperature/tool-call compatibility
|
||||||
|
- Fixed several UI polish issues in the extension and website, including cursor and layout regressions
|
||||||
|
|
||||||
|
## [1.5.1] - 2026-03-05
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
|
||||||
|
- **`data-browser-use-ignore` → `data-page-agent-ignore`** - DOM ignore attribute renamed to match the project identity
|
||||||
|
- **Config types restructured** - `PageAgentConfig` split into `AgentConfig` + `PageAgentCoreConfig`; config definitions moved from `config/index.ts` to `types.ts`
|
||||||
|
- **Zod v3/v4 dual support** - Libraries now accept both `zod@^3.25` and `zod@^4.0` as peer dependencies
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- **Experimental `llms.txt` support** - Agent can fetch and include a site's `llms.txt` in context. Enable via `experimentalLlmsTxt: true`
|
||||||
|
|
||||||
|
### Improvements
|
||||||
|
|
||||||
|
- Default `maxSteps` changed from 20 to 40 for better for complex tasks out of the box
|
||||||
|
- Added 400ms wait between agent steps for page reactions
|
||||||
|
- Increased click wait time (100ms → 200ms) for more reliable interactions
|
||||||
|
- Removed debug `console.log` statements from scroll actions
|
||||||
|
- Reset observations on new task start
|
||||||
|
- Improved logging across packages
|
||||||
|
|
||||||
|
### Extension v0.1.9
|
||||||
|
|
||||||
|
> PageAgent 1.5.1
|
||||||
|
|
||||||
|
- **Advanced config panel** - New collapsible section exposing Max Steps, System Instruction, and experimental `llms.txt` toggle
|
||||||
|
- Streamlined User Auth Token description
|
||||||
|
- Moved testing API notice below auth token section
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [1.4.0] - 2026-02-27
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Update Terms of Use and Privacy Policy
|
||||||
|
- **Robust tool-call validation** - Action inputs are now validated against tool schemas individually, producing clear error messages (e.g. `Invalid input for action "click_element_by_index"`) instead of unreadable union parse errors
|
||||||
|
- **Primitive action input coercion** - Small models that output `{"click_element_by_index": 2}` instead of `{"click_element_by_index": {"index": 2}}` are now auto-corrected using tool schemas
|
||||||
|
- **Qwen model updates** - Added `qwen3.5-plus` as the default free testing model; disabled `enable_thinking` for Qwen models to avoid incompatible responses
|
||||||
|
- **Updated default LLM endpoint** - Migrated demo and extension to a new testing endpoint with legacy endpoint auto-migration
|
||||||
|
|
||||||
|
### Improvements
|
||||||
|
|
||||||
|
- Unified zod imports (`* as z`) across all packages for consistency
|
||||||
|
- Better Zod error formatting with `z.prettifyError()` in LLM client
|
||||||
|
- Exported `InvokeError` and `InvokeErrorType` as values (not just types) from `@page-agent/llms`
|
||||||
|
- Exported `SupportedLanguage` type from `@page-agent/core`
|
||||||
|
|
||||||
|
### Extension v0.1.8
|
||||||
|
|
||||||
|
- **Language setting** - Added language selector (System / English / 中文) in config panel
|
||||||
|
- **UI makeover** - New empty state with breathing glow and typing animation; ai-motion glow overlay while running; refined focus styles
|
||||||
|
- **Testing endpoint notice** - Shows terms of use notice when using the free testing API
|
||||||
|
- **Legacy endpoint migration** - Auto-migrates old Supabase testing endpoint to new endpoint on startup
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [1.3.0] - 2026-02-13
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
|
||||||
|
- **Lifecycle: `stop()` vs `dispose()`** - New `stop()` method to cancel the current task while keeping the agent reusable. `dispose()` is now terminal — a disposed agent cannot be reused. This affects both `PageAgentCore` and `PanelAgentAdapter`.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- **Panel action button** - The panel button now morphs between Stop (■) and Close (X) based on agent status
|
||||||
|
- **Error history** - Errors and max-step failures are now recorded in `history` as `AgentErrorEvent`, making post-task analysis more complete
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- **AbortError handling** - `AbortError` is no longer retried by the LLM client, and shows a clean "Task stopped" message instead of a raw error stack
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [1.2.0] - 2026-02-11
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- **Observe Phase** - Agent now observes the page before each action, improving decision accuracy on dynamic pages
|
||||||
|
- **Better Abort Handling** - Improved `abortSignal` support for cleaner task cancellation
|
||||||
|
|
||||||
|
### Improvements
|
||||||
|
|
||||||
|
- Pruned system prompts for lower token usage and faster responses
|
||||||
|
- Improved error handling during agent steps with better error messages
|
||||||
|
- Zod tree-shaking for smaller bundle size
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Fixed indentation lost in DOM extraction caused by `trimLines`
|
||||||
|
- Fixed `gpt-5-mini` temperature configuration
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [1.1.0] - 2026-02-02
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- **Custom System Prompt** - New `systemPrompt` config option to customize or extend the default system prompt
|
||||||
|
- **Chrome Extension** - Extension with multi-tab control, main-world API with token auth, and tab lifecycle management
|
||||||
|
|
||||||
|
### Improvements
|
||||||
|
|
||||||
|
- Renamed `include_attributes` to `includeAttributes` in PageController config (camelCase consistency)
|
||||||
|
- Lazy-loaded mask module for faster initialization
|
||||||
|
- Better date formatting and error messages from LLM client
|
||||||
|
- Added `rawRequest` to step history for easier debugging
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Fixed CSP errors by using local SVGs for cursor mask instead of inline styles
|
||||||
|
- Fixed `AbortError` being incorrectly retried and shown to users
|
||||||
|
- Fixed mask not working correctly when starting a new task after stopping a previous one
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [1.0.0] - 2026-01-19
|
||||||
|
|
||||||
|
### 🎉 First Stable Release
|
||||||
|
|
||||||
|
PageAgent is now ready for production use. The API is stable and breaking changes will follow semantic versioning.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
#### Core
|
||||||
|
|
||||||
|
- **PageAgent** - Main entry class with built-in UI Panel
|
||||||
|
- **PageAgentCore** - Headless agent class for custom UI or programmatic use
|
||||||
|
- **DOM Analysis** - Text-based DOM extraction with high-intensity dehydration
|
||||||
|
- **LLM Support** - Works with OpenAI, Claude, DeepSeek, Qwen, and other OpenAI-compatible APIs
|
||||||
|
- **Tool System** - Built-in tools for click, input, scroll, select, and more
|
||||||
|
- **Custom Tools** - Extend agent capabilities with your own tools (experimental)
|
||||||
|
- **Lifecycle Hooks** - Hook into agent execution (experimental)
|
||||||
|
- **Instructions System** - System-level and page-level instructions to guide agent behavior
|
||||||
|
- **Data Masking** - Transform page content before sending to LLM
|
||||||
|
|
||||||
|
#### Page Controller
|
||||||
|
|
||||||
|
- **Element Interactions** - Click, input text, select options, scroll
|
||||||
|
- **Visual Mask** - Blocks user interaction during automation
|
||||||
|
- **DOM Tree Extraction** - Efficient page structure extraction for LLM consumption
|
||||||
|
|
||||||
|
#### UI
|
||||||
|
|
||||||
|
- **Interactive Panel** - Real-time task progress and agent thinking display
|
||||||
|
- **Ask User Tool** - Agent can ask users for clarification
|
||||||
|
- **i18n Support** - English and Chinese localization
|
||||||
|
|
||||||
|
### Packages
|
||||||
|
|
||||||
|
| Package | Description |
|
||||||
|
| ----------------------------- | ---------------------------------- |
|
||||||
|
| `page-agent` | Main entry with UI Panel |
|
||||||
|
| `@page-agent/core` | Core agent logic without UI |
|
||||||
|
| `@page-agent/llms` | LLM client with retry logic |
|
||||||
|
| `@page-agent/page-controller` | DOM operations and visual feedback |
|
||||||
|
| `@page-agent/ui` | Panel and i18n |
|
||||||
|
|
||||||
|
### Known Limitations
|
||||||
|
|
||||||
|
- Single-page application only (cannot navigate across pages)
|
||||||
|
- No visual recognition (relies on DOM structure)
|
||||||
|
- Limited interaction support (no hover, drag-drop, canvas operations)
|
||||||
|
- See [Limitations](https://alibaba.github.io/page-agent/docs/introduction/limitations) for details
|
||||||
|
|
||||||
|
### Acknowledgments
|
||||||
|
|
||||||
|
This project builds upon the excellent work of [browser-use](https://github.com/browser-use/browser-use). DOM processing components and prompts are adapted from browser-use (MIT License).
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
# Page Agent
|
||||||
|
|
||||||
|
<picture>
|
||||||
|
<source media="(prefers-color-scheme: dark)" srcset="https://img.alicdn.com/imgextra/i4/O1CN01qKig1P1FnhpFKNdi6_!!6000000000532-2-tps-1280-256.png">
|
||||||
|
<img alt="Page Agent Banner" src="https://img.alicdn.com/imgextra/i1/O1CN01NCMKXj1Gn4tkFTsxf_!!6000000000666-2-tps-1280-256.png">
|
||||||
|
</picture>
|
||||||
|
|
||||||
|
[](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [](https://bundlephobia.com/package/page-agent) [](https://www.npmjs.com/package/page-agent) [](https://github.com/alibaba/page-agent)
|
||||||
|
|
||||||
|
纯 JS 实现的 GUI agent。使用自然语言操作你的 Web 应用。无须后端、客户端、浏览器插件。
|
||||||
|
|
||||||
|
🌐 [English](../README.md) | **中文**
|
||||||
|
|
||||||
|
<a href="https://alibaba.github.io/page-agent/" target="_blank"><b>🚀 Demo</b></a> | <a href="https://alibaba.github.io/page-agent/docs/introduction/overview" target="_blank"><b>📖 Docs</b></a> | <a href="https://news.ycombinator.com/item?id=47264138" target="_blank"><b>📢 HN Discussion</b></a> | <a href="https://x.com/simonluvramen" target="_blank"><b>𝕏 Follow on X</b></a>
|
||||||
|
|
||||||
|
<video id="demo-video" src="https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2" controls crossorigin muted></video>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✨ Features
|
||||||
|
|
||||||
|
- **🎯 轻松集成**
|
||||||
|
- 无需 `浏览器插件` / `Python` / `无头浏览器`,纯页面内 JavaScript
|
||||||
|
- **📖 基于文本的 DOM 操作**
|
||||||
|
- 无需截图,无需多模态模型或特殊权限
|
||||||
|
- **🧠 自备 LLM**
|
||||||
|
- 🐙 可选的 [Chrome 扩展](https://alibaba.github.io/page-agent/docs/features/chrome-extension),支持跨页面任务
|
||||||
|
- [MCP Server (Beta)](https://alibaba.github.io/page-agent/docs/features/mcp-server)
|
||||||
|
|
||||||
|
## 💡 应用场景
|
||||||
|
|
||||||
|
- **SaaS AI Copilot** — 几行代码为你的产品加上 AI 副驾驶,无需重写后端。
|
||||||
|
- **智能表单填写** — 把 20 次点击变成一句话。ERP、CRM、管理后台的最佳拍档。
|
||||||
|
- **无障碍增强** — 用自然语言让任何网页无障碍。语音指令、屏幕阅读器,零门槛。
|
||||||
|
- **跨页面 Agent** — 通过可选的 [Chrome 扩展](https://alibaba.github.io/page-agent/docs/features/chrome-extension),让你自己的 Web Agent 跨标签页工作。
|
||||||
|
- 通过 MCP 为现有 Agent 加入浏览器控制能力。
|
||||||
|
|
||||||
|
## 🚀 快速开始
|
||||||
|
|
||||||
|
### 一行代码集成
|
||||||
|
|
||||||
|
通过我们免费的 Demo LLM 快速体验 PageAgent:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script src="{URL}" crossorigin="true"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
> **⚠️ 仅用于技术评估。** 该 Demo CDN 使用了免费的[测试 LLM API](https://alibaba.github.io/page-agent/docs/features/models#free-testing-api),使用即表示您同意其[条款](https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md)。
|
||||||
|
|
||||||
|
| Mirrors | URL |
|
||||||
|
| ------- | ---------------------------------------------------------------------------------- |
|
||||||
|
| Global | https://cdn.jsdelivr.net/npm/page-agent@1.8.0/dist/iife/page-agent.demo.js |
|
||||||
|
| China | https://registry.npmmirror.com/page-agent/1.8.0/files/dist/iife/page-agent.demo.js |
|
||||||
|
|
||||||
|
### NPM 安装
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install page-agent
|
||||||
|
```
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import { PageAgent } from 'page-agent'
|
||||||
|
|
||||||
|
const agent = new PageAgent({
|
||||||
|
model: 'qwen3.5-plus',
|
||||||
|
baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1',
|
||||||
|
apiKey: 'YOUR_API_KEY',
|
||||||
|
language: 'zh-CN',
|
||||||
|
})
|
||||||
|
|
||||||
|
await agent.execute('点击登录按钮')
|
||||||
|
```
|
||||||
|
|
||||||
|
更多编程用法,请参阅 [📖 文档](https://alibaba.github.io/page-agent/docs/introduction/overview)。
|
||||||
|
|
||||||
|
## 🤝 贡献
|
||||||
|
|
||||||
|
欢迎社区贡献!请参阅 [CONTRIBUTING.md](../CONTRIBUTING.md) 了解安装与贡献指南。
|
||||||
|
|
||||||
|
提交 issue 或 PR 之前,请先阅读[作者声明](https://github.com/alibaba/page-agent/issues/349)和[行为准则](CODE_OF_CONDUCT.md)。
|
||||||
|
|
||||||
|
我们不接受未经实质性人类参与、完全由 Bot 或 Agent 自动生成的代码。
|
||||||
|
|
||||||
|
## 👏 声明与致谢
|
||||||
|
|
||||||
|
本项目基于 **[`browser-use`](https://github.com/browser-use/browser-use)** 的优秀工作构建。
|
||||||
|
|
||||||
|
`PageAgent` 专为**客户端网页增强**设计,不是服务端自动化工具。
|
||||||
|
|
||||||
|
```
|
||||||
|
DOM processing components and prompt are derived from browser-use:
|
||||||
|
|
||||||
|
Browser Use <https://github.com/browser-use/browser-use>
|
||||||
|
Copyright (c) 2024 Gregor Zunic
|
||||||
|
Licensed under the MIT License
|
||||||
|
|
||||||
|
We gratefully acknowledge the browser-use project and its contributors for their
|
||||||
|
excellent work on web automation and DOM interaction patterns that helped make
|
||||||
|
this project possible.
|
||||||
|
```
|
||||||
|
|
||||||
|
## ⚖️ 许可证
|
||||||
|
|
||||||
|
[MIT License](../LICENSE)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**⭐ 如果觉得 PageAgent 有用或有趣,请给项目点个星!**
|
||||||
|
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
We provide security fixes on a best-effort basis for:
|
||||||
|
|
||||||
|
| Version | Supported |
|
||||||
|
| --------------------------------------------------------- | --------- |
|
||||||
|
| `main` | Yes |
|
||||||
|
| Latest npm release of `page-agent` and workspace packages | Yes |
|
||||||
|
| Older releases | No |
|
||||||
|
|
||||||
|
Please upgrade to the latest release before reporting an issue against an older build.
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.
|
||||||
|
|
||||||
|
Use GitHub's private vulnerability reporting flow:
|
||||||
|
|
||||||
|
- Open https://github.com/alibaba/page-agent/security/policy
|
||||||
|
- Click `Report a vulnerability`
|
||||||
|
|
||||||
|
If private reporting is unavailable, open a minimal public issue only to request a private contact channel. Do not include exploit details.
|
||||||
|
|
||||||
|
## What to Include
|
||||||
|
|
||||||
|
- Affected package or feature
|
||||||
|
- Exact version, commit, or build
|
||||||
|
- Browser, OS, and runtime environment
|
||||||
|
- Reproduction steps or a proof of concept
|
||||||
|
- Expected impact
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
We prioritize reports that show a real security boundary failure, such as:
|
||||||
|
|
||||||
|
- Unauthorized access to data, tokens, or extension capabilities
|
||||||
|
- Bypassing explicit safety constraints
|
||||||
|
- Sensitive data exposure caused by default behavior
|
||||||
|
|
||||||
|
The following usually do not qualify by themselves:
|
||||||
|
|
||||||
|
- Unsafe custom integrations that ignore documented safeguards
|
||||||
|
- Intentionally embedding secrets into client-side builds
|
||||||
|
- Reports against unsupported older versions
|
||||||
|
|
||||||
|
## Disclosure
|
||||||
|
|
||||||
|
Please avoid public disclosure until maintainers have had a reasonable chance to investigate and ship a fix.
|
||||||
@@ -0,0 +1,117 @@
|
|||||||
|
# Developer Guide
|
||||||
|
|
||||||
|
This file is for local development workflows.
|
||||||
|
|
||||||
|
For contribution rules and expectations, see [../CONTRIBUTING.md](../CONTRIBUTING.md).
|
||||||
|
|
||||||
|
## 🚀 Quick Start
|
||||||
|
|
||||||
|
### Development Setup
|
||||||
|
|
||||||
|
1. **Prerequisites**
|
||||||
|
- `macOS` / `Linux` / `WSL`
|
||||||
|
- `node.js >= 24` with `npm >= 11`
|
||||||
|
- An editor that supports `ts/eslint/prettier`
|
||||||
|
- Make sure `eslint`, `prettier` and `commitlint` work well. Un-linted code won't pass the CI.
|
||||||
|
|
||||||
|
2. **Setup**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm i
|
||||||
|
npm start # Start demo and documentation site
|
||||||
|
npm run build # Build libs and website
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📦 Project Structure
|
||||||
|
|
||||||
|
This is a **monorepo** with npm workspaces containing **4 main packages**:
|
||||||
|
|
||||||
|
- **Page Agent** (`packages/page-agent/`) - Main entry with built-in UI Panel, published as `page-agent` on npm
|
||||||
|
- **Core** (`packages/core/`) - Core agent logic without UI (npm: `@page-agent/core`)
|
||||||
|
- **Extension** (`packages/extension/`) - Chrome extension for multi-page tasks and browser-level automation
|
||||||
|
- **Website** (`packages/website/`) - React documentation and landing page. Also as demo and test page for the core lib. private package `@page-agent/website`
|
||||||
|
|
||||||
|
> We use a simplified monorepo solution with `native npm-workspace + ts reference + vite alias`. No fancy tooling. Hoisting is required.
|
||||||
|
>
|
||||||
|
> - When developing. Use alias so that we don't have to pre-build.
|
||||||
|
> - When bundling. Use external and disable ts `paths` alias.
|
||||||
|
> - When bundling `IIFE` and `Website`. Bundle everything together.
|
||||||
|
|
||||||
|
## 🤖 AGENTS.md Alias
|
||||||
|
|
||||||
|
If your AI assistant does not support [AGENTS.md](https://agents.md/). Add an alias for it:
|
||||||
|
|
||||||
|
- claude-code (`CLAUDE.md`)
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
@AGENTS.md
|
||||||
|
```
|
||||||
|
|
||||||
|
- antigravity (`.agent/rules/alias.md`)
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
---
|
||||||
|
trigger: always_on
|
||||||
|
---
|
||||||
|
|
||||||
|
@../../AGENTS.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔧 Development Workflows
|
||||||
|
|
||||||
|
### Test With Your Own LLM API
|
||||||
|
|
||||||
|
- Create a `.env` file in the repo root with your LLM API config
|
||||||
|
|
||||||
|
```env
|
||||||
|
LLM_MODEL_NAME=gpt-5.2
|
||||||
|
LLM_API_KEY=your-api-key
|
||||||
|
LLM_BASE_URL=https://api.your-llm-provider.com/v1
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Ollama example** (tested on 0.15 + qwen3:14b, RTX3090 24GB):
|
||||||
|
|
||||||
|
```env
|
||||||
|
LLM_BASE_URL="http://localhost:11434/v1"
|
||||||
|
LLM_API_KEY="NA"
|
||||||
|
LLM_MODEL_NAME="qwen3:14b"
|
||||||
|
```
|
||||||
|
|
||||||
|
> @see https://alibaba.github.io/page-agent/docs/features/models#ollama for configuration
|
||||||
|
|
||||||
|
- **Restart the dev server** to load new env vars
|
||||||
|
- If not provided, the demo will use the free testing proxy by default. By using it, you agree to its [terms](./terms-and-privacy.md).
|
||||||
|
|
||||||
|
### Extension Development
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# make sure you ran `npm run build:libs` first and every time you changed the core libs
|
||||||
|
npm run dev -w @page-agent/ext
|
||||||
|
npm run zip -w @page-agent/ext
|
||||||
|
```
|
||||||
|
|
||||||
|
- Update `packages/extension/docs/extension_api.md` for API integration details
|
||||||
|
|
||||||
|
### Testing on Other Websites
|
||||||
|
|
||||||
|
- Start and serve a local `iife` script
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run dev:demo # Serving IIFE with auto rebuild at http://localhost:5174/page-agent.demo.js
|
||||||
|
```
|
||||||
|
|
||||||
|
- Add a new bookmark
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
javascript:(function(){var s=document.createElement('script');s.src=`http://localhost:5174/page-agent.demo.js?t=${Math.random()}`;s.onload=()=>console.log(%27PageAgent ready!%27);document.head.appendChild(s);})();
|
||||||
|
```
|
||||||
|
|
||||||
|
- Click the bookmark on any page to load Page-Agent
|
||||||
|
|
||||||
|
> Warning: AK in your local `.env` will be inlined in the iife script. Be very careful when you distribute the script.
|
||||||
|
|
||||||
|
### Adding Documentation
|
||||||
|
|
||||||
|
Ask an AI to help you add documentation to the `website/` package. Follow the existing style.
|
||||||
|
|
||||||
|
> Our AGENTS.md file and guardrails are designed for this purpose. But please be careful and review anything AI generated.
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
# Terms of Use & Privacy
|
||||||
|
|
||||||
|
**Last updated:** March 2026
|
||||||
|
|
||||||
|
"We" in this document refers to the maintainers of the open-source Page Agent project (https://github.com/alibaba/page-agent). "The software" refers to Page Agent (the JavaScript library) and Page Agent Ext (the browser extension). This document covers the software itself and the testing API we provide — **not** any third-party product or service built with it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. Open Source Software Privacy
|
||||||
|
|
||||||
|
The software is a **client-side only** tool with a "Bring Your Own Key" (BYOK) architecture. The software itself does **not** include any backend service. The software does **not** collect or transmit any user data on its own, and we do **not** have access to your browsing activity, page content, or task instructions through the software.
|
||||||
|
|
||||||
|
All data transmission occurs **only** between your browser and the LLM provider you configure. You are in full control of which provider receives your data.
|
||||||
|
|
||||||
|
The project is open source under the [MIT License](https://github.com/alibaba/page-agent/blob/main/LICENSE) and can be audited at: https://github.com/alibaba/page-agent
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. Testing API and Demo Disclaimer & Terms of Use
|
||||||
|
|
||||||
|
To facilitate easy testing and technical evaluation, we provide a free testing LLM API. This API is used in the project homepage's live demo, the pre-built demo CDN bundles, and the browser extension's default configuration. Users may also use it independently for their own technical evaluation of the software.
|
||||||
|
|
||||||
|
This free testing API is provided **strictly for technical evaluation and R&D purposes only**. It must not be used in any production environment. By using this API, you agree to the following terms:
|
||||||
|
|
||||||
|
- **Permitted Use Only**: This API must be used solely for technical evaluation of the software. Any other use — including integration into other products or services, unlawful activities, violation of the underlying LLM provider's usage policies, or automated scraping at scale — is strictly prohibited.
|
||||||
|
|
||||||
|
- **No Sensitive Data**: You are strictly prohibited from inputting any Personal Identifiable Information (PII), confidential business data, financial/medical records, or using this agent on web pages containing such sensitive information.
|
||||||
|
|
||||||
|
- **Data Processing**: We do not store or log your prompts, webpage data (HTML), or any submitted content, nor do we use such data for model training. All data is processed in-transit and immediately discarded. We perform in-memory request validation to prevent abuse of the testing API, and temporarily process IP addresses for rate-limiting purposes. No data from these processes is retained. Data is processed through Alibaba Cloud infrastructure, which is subject to its own privacy policy.
|
||||||
|
|
||||||
|
- **Independent Infrastructure**: The software is completely frontend-based with a "Bring Your Own Key" (BYOK) architecture and **no built-in backend**. To facilitate easy testing, the maintainers have purchased public cloud services from Alibaba Cloud China ([aliyun.com](https://www.aliyun.com) Function Compute and BaiLian Qwen models). This project is not a product of, nor endorsed by, Alibaba Cloud.
|
||||||
|
|
||||||
|
- **No Guaranteed Availability**: This testing API may be rate-limited, degraded, or discontinued at any time without prior notice.
|
||||||
|
|
||||||
|
- **"AS IS" & Limitation of Liability**: This service is provided strictly on an "AS IS" and "AS AVAILABLE" basis, without any warranties. The maintainers bear no liability for any data loss, service interruption, or legal consequences arising from your use of this service.
|
||||||
|
|
||||||
|
- **Recommendation for Real Usage**: For secure and continuous usage, we strongly advise using the BYOK mode with your own legally compliant commercial LLM API keys, or connecting to local, offline models (e.g., Ollama).
|
||||||
|
|
||||||
|
**Note**: This free testing LLM API processes data via servers located in Mainland China. If you are located in a region with strict data localization laws (such as the EU/EEA), please do not use this API.
|
||||||
|
|
||||||
|
**Age Requirement**: The software and testing API are not intended for use by individuals under the age of 13 (or the minimum age of digital consent in your jurisdiction).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Browser Extension (Page Agent Ext)
|
||||||
|
|
||||||
|
### Data Processing
|
||||||
|
|
||||||
|
The extension performs DOM analysis and automation actions **locally in your browser**. Your browsing history, passwords, and form data are not accessed or collected by the extension developer.
|
||||||
|
|
||||||
|
Data is transmitted to external servers **only when you initiate an automation task**. When this occurs:
|
||||||
|
|
||||||
|
- Your task instructions (natural language commands)
|
||||||
|
- Simplified page structure (cleaned HTML) of all pages under the extension's control
|
||||||
|
|
||||||
|
are sent to the LLM API endpoint configured in **your settings**.
|
||||||
|
|
||||||
|
> **Note:** The HTML cleaning process simplifies page structure for AI readability but **does not guarantee removal of sensitive information** (e.g., visible text, form values, or personal data on the page). Please be mindful of the page content when initiating tasks.
|
||||||
|
|
||||||
|
**If you configure a third-party LLM provider** (e.g., OpenAI, Anthropic, or others), data is sent directly to that provider. Their privacy policies apply.
|
||||||
|
|
||||||
|
**If you use the testing API**, the terms in [Section 2](#2-testing-api-and-demo-disclaimer--terms-of-use) apply. By using the extension with the default testing API, you agree to those terms.
|
||||||
|
|
||||||
|
### Data Storage
|
||||||
|
|
||||||
|
- **Local storage only**: Your configuration (API endpoint, API key, model selection) is stored in your browser via `chrome.storage.local` (or equivalent browser storage APIs)
|
||||||
|
- **No cloud sync**: Configuration is not synced to any external server
|
||||||
|
- **No analytics**: The extension does not include any analytics or tracking code
|
||||||
|
|
||||||
|
### Your Control
|
||||||
|
|
||||||
|
- The extension is open source and can be audited by anyone
|
||||||
|
- You choose which LLM provider to use
|
||||||
|
- You may configure your own API endpoint at any time
|
||||||
|
- You can clear all stored data by removing the extension
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
We may update these terms at our discretion.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
https://github.com/alibaba/page-agent/issues
|
||||||
+6
-29
@@ -1,8 +1,5 @@
|
|||||||
|
import eslintReact from '@eslint-react/eslint-plugin'
|
||||||
import js from '@eslint/js'
|
import js from '@eslint/js'
|
||||||
import reactDom from 'eslint-plugin-react-dom'
|
|
||||||
import reactHooks from 'eslint-plugin-react-hooks'
|
|
||||||
import reactRefresh from 'eslint-plugin-react-refresh'
|
|
||||||
import reactX from 'eslint-plugin-react-x'
|
|
||||||
import { defineConfig, globalIgnores } from 'eslint/config'
|
import { defineConfig, globalIgnores } from 'eslint/config'
|
||||||
import globals from 'globals'
|
import globals from 'globals'
|
||||||
import tseslint from 'typescript-eslint'
|
import tseslint from 'typescript-eslint'
|
||||||
@@ -15,44 +12,24 @@ export default defineConfig([
|
|||||||
'**/.wxt',
|
'**/.wxt',
|
||||||
'**/.output',
|
'**/.output',
|
||||||
]),
|
]),
|
||||||
{
|
|
||||||
plugins: {
|
|
||||||
'react-hooks': reactHooks,
|
|
||||||
},
|
|
||||||
rules: reactHooks.configs.recommended.rules,
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
files: ['**/*.{ts,tsx}'],
|
files: ['**/*.{ts,tsx}'],
|
||||||
extends: [
|
extends: [
|
||||||
js.configs.recommended,
|
js.configs.recommended,
|
||||||
tseslint.configs.recommended,
|
tseslint.configs.recommended,
|
||||||
// reactHooks.configs['recommended-latest'],
|
|
||||||
reactRefresh.configs.vite,
|
|
||||||
|
|
||||||
// Remove tseslint.configs.recommended and replace with this
|
|
||||||
...tseslint.configs.recommendedTypeChecked,
|
...tseslint.configs.recommendedTypeChecked,
|
||||||
// Alternatively, use this for stricter rules
|
|
||||||
...tseslint.configs.strictTypeChecked,
|
...tseslint.configs.strictTypeChecked,
|
||||||
// Optionally, add this for stylistic rules
|
|
||||||
...tseslint.configs.stylisticTypeChecked,
|
...tseslint.configs.stylisticTypeChecked,
|
||||||
|
eslintReact.configs['recommended-typescript'],
|
||||||
// Enable lint rules for React
|
|
||||||
reactX.configs['recommended-typescript'],
|
|
||||||
// Enable lint rules for React DOM
|
|
||||||
reactDom.configs.recommended,
|
|
||||||
],
|
],
|
||||||
languageOptions: {
|
languageOptions: {
|
||||||
parserOptions: {
|
parserOptions: {
|
||||||
// project: ['./tsconfig.json'],
|
|
||||||
// project: ['./packages/*/tsconfig.json'],
|
|
||||||
// tsconfigRootDir: import.meta.dirname,
|
|
||||||
projectService: true,
|
projectService: true,
|
||||||
},
|
},
|
||||||
ecmaVersion: 2020,
|
ecmaVersion: 2020,
|
||||||
globals: globals.browser,
|
globals: globals.browser,
|
||||||
},
|
},
|
||||||
rules: {
|
rules: {
|
||||||
// Add any additional rules here
|
|
||||||
'@typescript-eslint/no-non-null-assertion': 'off',
|
'@typescript-eslint/no-non-null-assertion': 'off',
|
||||||
'@typescript-eslint/no-unsafe-assignment': 'off',
|
'@typescript-eslint/no-unsafe-assignment': 'off',
|
||||||
'@typescript-eslint/no-unsafe-member-access': 'off',
|
'@typescript-eslint/no-unsafe-member-access': 'off',
|
||||||
@@ -72,14 +49,14 @@ export default defineConfig([
|
|||||||
'@typescript-eslint/no-unsafe-argument': 'off',
|
'@typescript-eslint/no-unsafe-argument': 'off',
|
||||||
'@typescript-eslint/no-unsafe-return': 'off',
|
'@typescript-eslint/no-unsafe-return': 'off',
|
||||||
'@typescript-eslint/restrict-plus-operands': 'off',
|
'@typescript-eslint/restrict-plus-operands': 'off',
|
||||||
'react-dom/no-missing-button-type': 'off',
|
|
||||||
'react-x/no-nested-component-definitions': 'off',
|
|
||||||
'@typescript-eslint/prefer-optional-chain': 'off',
|
'@typescript-eslint/prefer-optional-chain': 'off',
|
||||||
'@typescript-eslint/use-unknown-in-catch-callback-variable': 'off',
|
'@typescript-eslint/use-unknown-in-catch-callback-variable': 'off',
|
||||||
'@typescript-eslint/no-unnecessary-type-parameters': 'off',
|
'@typescript-eslint/no-unnecessary-type-parameters': 'off',
|
||||||
|
|
||||||
// 'require-await': 'off',
|
|
||||||
'@typescript-eslint/require-await': 'off',
|
'@typescript-eslint/require-await': 'off',
|
||||||
|
'@eslint-react/dom-no-missing-button-type': 'off',
|
||||||
|
'@eslint-react/no-nested-component-definitions': 'off',
|
||||||
|
'@eslint-react/no-array-index-key': 'off',
|
||||||
|
'@eslint-react/dom-no-dangerously-set-innerhtml': 'off',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
])
|
])
|
||||||
|
|||||||
Generated
+3566
-1960
File diff suppressed because it is too large
Load Diff
+32
-28
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "root",
|
"name": "root",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "1.1.0",
|
"version": "1.8.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"workspaces": [
|
"workspaces": [
|
||||||
"packages/page-controller",
|
"packages/page-controller",
|
||||||
@@ -9,6 +9,7 @@
|
|||||||
"packages/llms",
|
"packages/llms",
|
||||||
"packages/core",
|
"packages/core",
|
||||||
"packages/page-agent",
|
"packages/page-agent",
|
||||||
|
"packages/mcp",
|
||||||
"packages/extension",
|
"packages/extension",
|
||||||
"packages/website"
|
"packages/website"
|
||||||
],
|
],
|
||||||
@@ -21,48 +22,51 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://alibaba.github.io/page-agent/",
|
"homepage": "https://alibaba.github.io/page-agent/",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=20.0.0",
|
"node": "^22.13.0 || >=24"
|
||||||
"npm": ">=10.0.0"
|
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"cleanup": "rm -rf packages/*/dist",
|
|
||||||
"start": "npm run dev --workspace=@page-agent/website",
|
"start": "npm run dev --workspace=@page-agent/website",
|
||||||
"build:website": "npm run build:website --workspace=@page-agent/website",
|
"dev:ext": "npm run dev -w @page-agent/ext",
|
||||||
"build:libs": "npm run build --workspaces --if-present",
|
|
||||||
"build": "npm run build:libs && npm run build:website",
|
|
||||||
"dev:demo": "npm run dev:demo --workspace=page-agent",
|
"dev:demo": "npm run dev:demo --workspace=page-agent",
|
||||||
|
"build": "npm run build:libs && npm run build:website",
|
||||||
|
"build:libs": "npm run build --workspaces --if-present",
|
||||||
|
"build:website": "npm run build:website --workspace=@page-agent/website",
|
||||||
|
"build:ext": "npm run build:libs && npm run zip -w @page-agent/ext",
|
||||||
"version": "node scripts/sync-version.js",
|
"version": "node scripts/sync-version.js",
|
||||||
|
"postpublish": "npm run postpublish --workspaces --if-present",
|
||||||
|
"typecheck": "tsc --noEmit -p tsconfig.typecheck.json && tsc --noEmit -p packages/extension/tsconfig.json",
|
||||||
"lint": "eslint .",
|
"lint": "eslint .",
|
||||||
"prepare": "husky"
|
"cleanup": "rm -rf packages/*/dist && rm -rf packages/*/.output",
|
||||||
|
"prepare": "husky || true"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "^20.3.1",
|
"@commitlint/cli": "^20.5.0",
|
||||||
"@commitlint/config-conventional": "^20.3.1",
|
"@commitlint/config-conventional": "^20.5.0",
|
||||||
"@eslint/js": "^9.39.2",
|
"@eslint-react/eslint-plugin": "^4.2.3",
|
||||||
"@microsoft/api-extractor": "^7.55.2",
|
"@eslint/js": "^10.0.1",
|
||||||
|
"@microsoft/api-extractor": "^7.58.2",
|
||||||
|
"@tailwindcss/vite": "^4.2.2",
|
||||||
"@trivago/prettier-plugin-sort-imports": "^6.0.2",
|
"@trivago/prettier-plugin-sort-imports": "^6.0.2",
|
||||||
"@types/node": "^25.0.9",
|
"@types/node": "^25.6.0",
|
||||||
|
"@vitejs/plugin-react-swc": "^4.3.0",
|
||||||
"chalk": "^5.6.2",
|
"chalk": "^5.6.2",
|
||||||
"concurrently": "^9.2.1",
|
"concurrently": "^9.2.1",
|
||||||
"dotenv": "^17.2.3",
|
"dotenv": "^17.4.2",
|
||||||
"eslint": "^9.39.2",
|
"eslint": "^10.2.0",
|
||||||
"eslint-config-prettier": "^10.1.8",
|
"globals": "^17.5.0",
|
||||||
"eslint-plugin-react-dom": "^2.7.2",
|
|
||||||
"eslint-plugin-react-hooks": "^7.0.1",
|
|
||||||
"eslint-plugin-react-refresh": "^0.5.0",
|
|
||||||
"eslint-plugin-react-x": "^2.7.2",
|
|
||||||
"globals": "^17.0.0",
|
|
||||||
"husky": "^9.1.7",
|
"husky": "^9.1.7",
|
||||||
"lint-staged": "^16.2.4",
|
"lint-staged": "^16.4.0",
|
||||||
"prettier": "^3.8.0",
|
"prettier": "^3.8.2",
|
||||||
"typescript": "^5.9.3",
|
"typescript": "^6.0.2",
|
||||||
"typescript-eslint": "^8.54.0",
|
"typescript-eslint": "^8.58.2",
|
||||||
"unplugin-dts": "^1.0.0-beta.6",
|
"unplugin-dts": "^1.0.0-beta.6",
|
||||||
"vite": "^7.3.1",
|
"vite": "^7.3.2",
|
||||||
"vite-plugin-css-injected-by-js": "^3.5.2"
|
"vite-bundle-analyzer": "^1.3.7",
|
||||||
|
"vite-plugin-css-injected-by-js": "^4.0.1"
|
||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"typescript": "^5.9.3"
|
"typescript": "^6.0.2",
|
||||||
|
"@vitejs/plugin-react": "^5.2.0"
|
||||||
},
|
},
|
||||||
"lint-staged": {
|
"lint-staged": {
|
||||||
"*.{js,ts,cjs,cts,mjs,mts}": [
|
"*.{js,ts,cjs,cts,mjs,mts}": [
|
||||||
|
|||||||
+27
-12
@@ -1,16 +1,26 @@
|
|||||||
{
|
{
|
||||||
"name": "@page-agent/core",
|
"name": "@page-agent/core",
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "1.1.0",
|
"version": "1.8.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./dist/esm/page-agent-core.js",
|
"main": "./src/PageAgentCore.ts",
|
||||||
"module": "./dist/esm/page-agent-core.js",
|
"types": "./src/PageAgentCore.ts",
|
||||||
"types": "./dist/esm/PageAgentCore.d.ts",
|
|
||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"types": "./dist/esm/PageAgentCore.d.ts",
|
"types": "./src/PageAgentCore.ts",
|
||||||
"import": "./dist/esm/page-agent-core.js",
|
"default": "./src/PageAgentCore.ts"
|
||||||
"default": "./dist/esm/page-agent-core.js"
|
}
|
||||||
|
},
|
||||||
|
"publishConfig": {
|
||||||
|
"main": "./dist/esm/page-agent-core.js",
|
||||||
|
"module": "./dist/esm/page-agent-core.js",
|
||||||
|
"types": "./dist/esm/PageAgentCore.d.ts",
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"types": "./dist/esm/PageAgentCore.d.ts",
|
||||||
|
"import": "./dist/esm/page-agent-core.js",
|
||||||
|
"default": "./dist/esm/page-agent-core.js"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
@@ -39,13 +49,18 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "vite build",
|
"build": "vite build",
|
||||||
"dev:iife": "concurrently \"vite build --config vite.iife.config.js --watch\" \"npx serve dist/iife -p 5174\"",
|
"dev:iife": "concurrently \"vite build --config vite.iife.config.js --watch\" \"npx serve dist/iife -p 5174\"",
|
||||||
"prepublishOnly": "node -e \"const fs=require('fs');['README.md','LICENSE'].forEach(f=>fs.copyFileSync('../../'+f,f))\"",
|
"prepublishOnly": "node ../../scripts/pre-publish.js",
|
||||||
"postpublish": "node -e \"['README.md','LICENSE'].forEach(f=>{try{require('fs').unlinkSync(f)}catch{}})\""
|
"postpublish": "node ../../scripts/post-publish.js"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"chalk": "^5.6.2",
|
"chalk": "^5.6.2",
|
||||||
"zod": "^4.3.5",
|
"@page-agent/llms": "1.8.0",
|
||||||
"@page-agent/llms": "1.1.0",
|
"@page-agent/page-controller": "1.8.0"
|
||||||
"@page-agent/page-controller": "1.1.0"
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"zod": "^3.25.0 || ^4.0.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"zod": "^4.3.6"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+197
-147
@@ -1,18 +1,18 @@
|
|||||||
/**
|
/**
|
||||||
* Copyright (C) 2025 Alibaba Group Holding Limited
|
* Copyright (C) 2025 Alibaba Group Holding Limited
|
||||||
|
* Copyright (C) 2026 SimonLuvRamen
|
||||||
* All rights reserved.
|
* All rights reserved.
|
||||||
*/
|
*/
|
||||||
import { InvokeError, LLM, type Tool } from '@page-agent/llms'
|
import { InvokeError, LLM, type Tool } from '@page-agent/llms'
|
||||||
import type { PageController } from '@page-agent/page-controller'
|
import type { BrowserState, PageController } from '@page-agent/page-controller'
|
||||||
import chalk from 'chalk'
|
import chalk from 'chalk'
|
||||||
import zod from 'zod'
|
import * as z from 'zod/v4'
|
||||||
|
|
||||||
import { type PageAgentConfig } from './config'
|
|
||||||
import { DEFAULT_MAX_STEPS } from './config/constants'
|
|
||||||
import SYSTEM_PROMPT from './prompts/system_prompt.md?raw'
|
import SYSTEM_PROMPT from './prompts/system_prompt.md?raw'
|
||||||
import { tools } from './tools'
|
import { tools } from './tools'
|
||||||
import {
|
import type {
|
||||||
AgentActivity,
|
AgentActivity,
|
||||||
|
AgentConfig,
|
||||||
AgentReflection,
|
AgentReflection,
|
||||||
AgentStatus,
|
AgentStatus,
|
||||||
AgentStepEvent,
|
AgentStepEvent,
|
||||||
@@ -21,17 +21,26 @@ import {
|
|||||||
MacroToolInput,
|
MacroToolInput,
|
||||||
MacroToolResult,
|
MacroToolResult,
|
||||||
} from './types'
|
} from './types'
|
||||||
import { normalizeResponse, trimLines, uid, waitFor } from './utils'
|
import { assert, fetchLlmsTxt, normalizeResponse, uid, waitFor } from './utils'
|
||||||
import { assert } from './utils/assert'
|
|
||||||
|
|
||||||
export { type PageAgentConfig }
|
|
||||||
export { tool, type PageAgentTool } from './tools'
|
export { tool, type PageAgentTool } from './tools'
|
||||||
export type * from './types'
|
export type * from './types'
|
||||||
|
|
||||||
|
export type PageAgentCoreConfig = AgentConfig & { pageController: PageController }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* AI agent for browser DOM automation.
|
* AI agent for browser automation.
|
||||||
*
|
*
|
||||||
* @remarks
|
* @remarks
|
||||||
|
* ## Re-act Agent Loop
|
||||||
|
* - step
|
||||||
|
* - observe (gather information about current environment and context)
|
||||||
|
* - think (LLM calling)
|
||||||
|
* - reflection (evaluate history, generate memory, short-term planning)
|
||||||
|
* - action (give the action to approach the next goal)
|
||||||
|
* - act (execute the action)
|
||||||
|
* - loop
|
||||||
|
*
|
||||||
* ## Event System
|
* ## Event System
|
||||||
* - `statuschange` - Agent status transitions (idle → running → completed/error)
|
* - `statuschange` - Agent status transitions (idle → running → completed/error)
|
||||||
* - `historychange` - History events updated (persistent, part of agent memory)
|
* - `historychange` - History events updated (persistent, part of agent memory)
|
||||||
@@ -50,14 +59,18 @@ export type * from './types'
|
|||||||
* - Types: thinking, executing, executed, retrying, error
|
* - Types: thinking, executing, executed, retrying, error
|
||||||
*/
|
*/
|
||||||
export class PageAgentCore extends EventTarget {
|
export class PageAgentCore extends EventTarget {
|
||||||
config: PageAgentConfig & { maxSteps: number }
|
readonly id = uid()
|
||||||
id = uid()
|
readonly config: PageAgentCoreConfig & { maxSteps: number }
|
||||||
tools: typeof tools
|
readonly tools: typeof tools
|
||||||
|
/** PageController for DOM operations */
|
||||||
|
readonly pageController: PageController
|
||||||
|
|
||||||
task = ''
|
task = ''
|
||||||
taskId = ''
|
taskId = ''
|
||||||
|
/** History events */
|
||||||
/** Agent execution status */
|
history: HistoricalEvent[] = []
|
||||||
#status: AgentStatus = 'idle'
|
/** Whether this agent has been disposed */
|
||||||
|
disposed = false
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Callback for when agent needs user input (ask_user tool)
|
* Callback for when agent needs user input (ask_user tool)
|
||||||
@@ -66,27 +79,25 @@ export class PageAgentCore extends EventTarget {
|
|||||||
*/
|
*/
|
||||||
onAskUser?: (question: string) => Promise<string>
|
onAskUser?: (question: string) => Promise<string>
|
||||||
|
|
||||||
|
#status: AgentStatus = 'idle'
|
||||||
#llm: LLM
|
#llm: LLM
|
||||||
#abortController = new AbortController()
|
#abortController = new AbortController()
|
||||||
|
#observations: string[] = []
|
||||||
|
|
||||||
/** PageController for DOM operations */
|
/** internal states during a single task execution */
|
||||||
pageController: PageController
|
#states = {
|
||||||
|
/** Accumulated wait time in seconds */
|
||||||
/** Runtime states for tracking across steps */
|
|
||||||
states = {
|
|
||||||
/** Accumulated wait time in seconds, used by wait tool */
|
|
||||||
totalWaitTime: 0,
|
totalWaitTime: 0,
|
||||||
/** Last known URL for detecting navigation */
|
/** For detecting navigation */
|
||||||
lastURL: '',
|
lastURL: '',
|
||||||
|
/** Browser state */
|
||||||
|
browserState: null as BrowserState | null,
|
||||||
}
|
}
|
||||||
|
|
||||||
/** History events */
|
constructor(config: PageAgentCoreConfig) {
|
||||||
history: HistoricalEvent[] = []
|
|
||||||
|
|
||||||
constructor(config: PageAgentConfig & { pageController: PageController }) {
|
|
||||||
super()
|
super()
|
||||||
|
|
||||||
this.config = { ...config, maxSteps: config.maxSteps || DEFAULT_MAX_STEPS }
|
this.config = { ...config, maxSteps: config.maxSteps ?? 40 }
|
||||||
|
|
||||||
this.#llm = new LLM(this.config)
|
this.#llm = new LLM(this.config)
|
||||||
this.tools = new Map(tools)
|
this.tools = new Map(tools)
|
||||||
@@ -166,15 +177,24 @@ export class PageAgentCore extends EventTarget {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Push a persistent observation to the history event stream.
|
* Push an observation message to the history event stream.
|
||||||
* This will be visible in <agent_history> and remain in memory across steps.
|
* This will be visible in <agent_history> and remain persistent in memory across steps.
|
||||||
|
* @experimental @internal
|
||||||
|
* @note history change will be emitted before next step starts
|
||||||
*/
|
*/
|
||||||
pushObservation(content: string): void {
|
pushObservation(content: string): void {
|
||||||
this.history.push({ type: 'observation', content })
|
this.#observations.push(content)
|
||||||
this.#emitHistoryChange()
|
}
|
||||||
|
|
||||||
|
/** Stop the current task. Agent remains reusable. */
|
||||||
|
stop() {
|
||||||
|
this.pageController.cleanUpHighlights()
|
||||||
|
this.pageController.hideMask()
|
||||||
|
this.#abortController.abort()
|
||||||
}
|
}
|
||||||
|
|
||||||
async execute(task: string): Promise<ExecutionResult> {
|
async execute(task: string): Promise<ExecutionResult> {
|
||||||
|
if (this.disposed) throw new Error('PageAgent has been disposed. Create a new instance.')
|
||||||
if (!task) throw new Error('Task is required')
|
if (!task) throw new Error('Task is required')
|
||||||
this.task = task
|
this.task = task
|
||||||
this.taskId = uid()
|
this.taskId = uid()
|
||||||
@@ -202,45 +222,46 @@ export class PageAgentCore extends EventTarget {
|
|||||||
this.history = []
|
this.history = []
|
||||||
this.#setStatus('running')
|
this.#setStatus('running')
|
||||||
this.#emitHistoryChange()
|
this.#emitHistoryChange()
|
||||||
|
this.#observations = []
|
||||||
|
|
||||||
// Reset states
|
// Reset internal states
|
||||||
this.states = {
|
this.#states = { totalWaitTime: 0, lastURL: '', browserState: null }
|
||||||
totalWaitTime: 0,
|
|
||||||
lastURL: '',
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
let step = 0
|
||||||
let step = 0
|
|
||||||
|
|
||||||
while (true) {
|
while (true) {
|
||||||
await this.#generateObservations(step)
|
try {
|
||||||
|
console.group(`step: ${step}`)
|
||||||
|
|
||||||
await onBeforeStep?.(this, step)
|
await onBeforeStep?.(this, step)
|
||||||
|
|
||||||
console.group(`step: ${step}`)
|
// observe
|
||||||
|
|
||||||
// abort
|
console.log(chalk.blue.bold('👀 Observing...'))
|
||||||
if (this.#abortController.signal.aborted) throw new Error('AbortError')
|
|
||||||
|
|
||||||
// Thinking
|
this.#states.browserState = await this.pageController.getBrowserState()
|
||||||
console.log(chalk.blue('Thinking...'))
|
await this.#handleObservations(step)
|
||||||
this.#emitActivity({ type: 'thinking' })
|
|
||||||
|
|
||||||
// invoke LLM
|
// assemble prompts
|
||||||
|
|
||||||
const messages = [
|
const messages = [
|
||||||
{ role: 'system' as const, content: this.#getSystemPrompt() },
|
{ role: 'system' as const, content: this.#getSystemPrompt() },
|
||||||
{ role: 'user' as const, content: await this.#assembleUserPrompt() },
|
{ role: 'user' as const, content: await this.#assembleUserPrompt() },
|
||||||
]
|
]
|
||||||
|
|
||||||
const tools = { AgentOutput: this.#packMacroTool() }
|
const macroTool = { AgentOutput: this.#packMacroTool() }
|
||||||
|
|
||||||
const result = await this.#llm.invoke(messages, tools, this.#abortController.signal, {
|
// invoke LLM
|
||||||
|
|
||||||
|
console.log(chalk.blue.bold('🧠 Thinking...'))
|
||||||
|
this.#emitActivity({ type: 'thinking' })
|
||||||
|
|
||||||
|
const result = await this.#llm.invoke(messages, macroTool, this.#abortController.signal, {
|
||||||
toolChoiceName: 'AgentOutput',
|
toolChoiceName: 'AgentOutput',
|
||||||
normalizeResponse,
|
normalizeResponse: (res) => normalizeResponse(res, this.tools),
|
||||||
})
|
})
|
||||||
|
|
||||||
// assemble history event
|
// assemble history
|
||||||
|
|
||||||
const macroResult = result.toolResult as MacroToolResult
|
const macroResult = result.toolResult as MacroToolResult
|
||||||
const input = macroResult.input
|
const input = macroResult.input
|
||||||
@@ -270,22 +291,12 @@ export class PageAgentCore extends EventTarget {
|
|||||||
|
|
||||||
//
|
//
|
||||||
|
|
||||||
console.log(chalk.green('Step finished:'), actionName)
|
|
||||||
console.groupEnd()
|
|
||||||
|
|
||||||
await onAfterStep?.(this, this.history)
|
await onAfterStep?.(this, this.history)
|
||||||
|
|
||||||
step++
|
console.groupEnd()
|
||||||
if (step > this.config.maxSteps) {
|
|
||||||
this.#onDone(false)
|
// finish task if done
|
||||||
const result: ExecutionResult = {
|
|
||||||
success: false,
|
|
||||||
data: 'Step count exceeded maximum limit',
|
|
||||||
history: this.history,
|
|
||||||
}
|
|
||||||
await onAfterTask?.(this, result)
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
if (actionName === 'done') {
|
if (actionName === 'done') {
|
||||||
const success = action.input?.success ?? false
|
const success = action.input?.success ?? false
|
||||||
const text = action.input?.text || 'no text provided'
|
const text = action.input?.text || 'no text provided'
|
||||||
@@ -299,19 +310,41 @@ export class PageAgentCore extends EventTarget {
|
|||||||
await onAfterTask?.(this, result)
|
await onAfterTask?.(this, result)
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
} catch (error: unknown) {
|
||||||
|
console.groupEnd() // to prevent nested groups
|
||||||
|
const isAbortError = (error as any)?.rawError?.name === 'AbortError'
|
||||||
|
|
||||||
|
console.error('Task failed', error)
|
||||||
|
const errorMessage = isAbortError ? 'Task stopped' : String(error)
|
||||||
|
this.#emitActivity({ type: 'error', message: errorMessage })
|
||||||
|
this.history.push({ type: 'error', message: errorMessage, rawResponse: error })
|
||||||
|
this.#emitHistoryChange()
|
||||||
|
this.#onDone(false)
|
||||||
|
const result: ExecutionResult = {
|
||||||
|
success: false,
|
||||||
|
data: errorMessage,
|
||||||
|
history: this.history,
|
||||||
|
}
|
||||||
|
await onAfterTask?.(this, result)
|
||||||
|
return result
|
||||||
}
|
}
|
||||||
} catch (error: unknown) {
|
|
||||||
console.error('Task failed', error)
|
step++
|
||||||
const errorMessage = String(error)
|
if (step > this.config.maxSteps) {
|
||||||
this.#emitActivity({ type: 'error', message: errorMessage })
|
const errorMessage = 'Step count exceeded maximum limit'
|
||||||
this.#onDone(false)
|
this.history.push({ type: 'error', message: errorMessage })
|
||||||
const result: ExecutionResult = {
|
this.#emitHistoryChange()
|
||||||
success: false,
|
this.#onDone(false)
|
||||||
data: errorMessage,
|
const result: ExecutionResult = {
|
||||||
history: this.history,
|
success: false,
|
||||||
|
data: errorMessage,
|
||||||
|
history: this.history,
|
||||||
|
}
|
||||||
|
await onAfterTask?.(this, result)
|
||||||
|
return result
|
||||||
}
|
}
|
||||||
await onAfterTask?.(this, result)
|
|
||||||
return result
|
await waitFor(this.config.stepDelay ?? 0.4)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -328,29 +361,27 @@ export class PageAgentCore extends EventTarget {
|
|||||||
const tools = this.tools
|
const tools = this.tools
|
||||||
|
|
||||||
const actionSchemas = Array.from(tools.entries()).map(([toolName, tool]) => {
|
const actionSchemas = Array.from(tools.entries()).map(([toolName, tool]) => {
|
||||||
return zod.object({ [toolName]: tool.inputSchema }).describe(tool.description)
|
return z.object({ [toolName]: tool.inputSchema }).describe(tool.description)
|
||||||
})
|
})
|
||||||
|
|
||||||
const actionSchema = zod.union(
|
const actionSchema = z.union(actionSchemas as unknown as [z.ZodType, z.ZodType, ...z.ZodType[]])
|
||||||
actionSchemas as unknown as [zod.ZodType, zod.ZodType, ...zod.ZodType[]]
|
|
||||||
)
|
|
||||||
|
|
||||||
const macroToolSchema = zod.object({
|
const macroToolSchema = z.object({
|
||||||
// thinking: zod.string().optional(),
|
// thinking: z.string().optional(),
|
||||||
evaluation_previous_goal: zod.string().optional(),
|
evaluation_previous_goal: z.string().optional(),
|
||||||
memory: zod.string().optional(),
|
memory: z.string().optional(),
|
||||||
next_goal: zod.string().optional(),
|
next_goal: z.string().optional(),
|
||||||
action: actionSchema,
|
action: actionSchema,
|
||||||
})
|
})
|
||||||
|
|
||||||
return {
|
return {
|
||||||
description: 'You MUST call this tool every step. Outputs your reflections and next action.',
|
description: 'You MUST call this tool every step!',
|
||||||
inputSchema: macroToolSchema as zod.ZodType<MacroToolInput>,
|
inputSchema: macroToolSchema as z.ZodType<MacroToolInput>,
|
||||||
execute: async (input: MacroToolInput): Promise<MacroToolResult> => {
|
execute: async (input: MacroToolInput): Promise<MacroToolResult> => {
|
||||||
// abort
|
// abort
|
||||||
if (this.#abortController.signal.aborted) throw new Error('AbortError')
|
if (this.#abortController.signal.aborted) throw new Error('AbortError')
|
||||||
|
|
||||||
console.log(chalk.blue.bold('MacroTool execute'), input)
|
console.log(chalk.blue.bold('MacroTool input'), input)
|
||||||
const action = input.action
|
const action = input.action
|
||||||
|
|
||||||
const toolName = Object.keys(action)[0]
|
const toolName = Object.keys(action)[0]
|
||||||
@@ -371,7 +402,7 @@ export class PageAgentCore extends EventTarget {
|
|||||||
|
|
||||||
// Find the corresponding tool
|
// Find the corresponding tool
|
||||||
const tool = tools.get(toolName)
|
const tool = tools.get(toolName)
|
||||||
assert(tool, `Tool ${toolName} not found. (@note should have been caught before this!!!)`)
|
assert(tool, `Tool ${toolName} not found`)
|
||||||
|
|
||||||
console.log(chalk.blue.bold(`Executing tool: ${toolName}`), toolInput)
|
console.log(chalk.blue.bold(`Executing tool: ${toolName}`), toolInput)
|
||||||
|
|
||||||
@@ -395,9 +426,11 @@ export class PageAgentCore extends EventTarget {
|
|||||||
duration,
|
duration,
|
||||||
})
|
})
|
||||||
|
|
||||||
// Reset wait time for non-wait tools
|
// counting wait time
|
||||||
if (toolName !== 'wait') {
|
if (toolName === 'wait') {
|
||||||
this.states.totalWaitTime = 0
|
this.#states.totalWaitTime += toolInput?.seconds || 0
|
||||||
|
} else {
|
||||||
|
this.#states.totalWaitTime = 0
|
||||||
}
|
}
|
||||||
|
|
||||||
// Return structured result
|
// Return structured result
|
||||||
@@ -427,17 +460,16 @@ export class PageAgentCore extends EventTarget {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get instructions from config and format as XML block
|
* Get instructions from config
|
||||||
*/
|
*/
|
||||||
async #getInstructions(): Promise<string> {
|
async #getInstructions(): Promise<string> {
|
||||||
const { instructions } = this.config
|
const { instructions, experimentalLlmsTxt } = this.config
|
||||||
if (!instructions) return ''
|
|
||||||
|
|
||||||
const systemInstructions = instructions.system?.trim()
|
const systemInstructions = instructions?.system?.trim()
|
||||||
const url = await this.pageController.getCurrentUrl()
|
|
||||||
let pageInstructions: string | undefined
|
let pageInstructions: string | undefined
|
||||||
|
|
||||||
if (instructions.getPageInstructions) {
|
const url = this.#states.browserState?.url || ''
|
||||||
|
if (instructions?.getPageInstructions && url) {
|
||||||
try {
|
try {
|
||||||
pageInstructions = instructions.getPageInstructions(url)?.trim()
|
pageInstructions = instructions.getPageInstructions(url)?.trim()
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -447,7 +479,10 @@ export class PageAgentCore extends EventTarget {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (!systemInstructions && !pageInstructions) return ''
|
|
||||||
|
const llmsTxt = experimentalLlmsTxt && url ? await fetchLlmsTxt(url) : undefined
|
||||||
|
|
||||||
|
if (!systemInstructions && !pageInstructions && !llmsTxt) return ''
|
||||||
|
|
||||||
let result = '<instructions>\n'
|
let result = '<instructions>\n'
|
||||||
|
|
||||||
@@ -459,44 +494,68 @@ export class PageAgentCore extends EventTarget {
|
|||||||
result += `<page_instructions>\n${pageInstructions}\n</page_instructions>\n`
|
result += `<page_instructions>\n${pageInstructions}\n</page_instructions>\n`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (llmsTxt) {
|
||||||
|
result += `<llms_txt>\n${llmsTxt}\n</llms_txt>\n`
|
||||||
|
}
|
||||||
|
|
||||||
result += '</instructions>\n\n'
|
result += '</instructions>\n\n'
|
||||||
|
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generate observations before each step
|
* Generate system observations before each step
|
||||||
* - URL change detection
|
|
||||||
* - Too many steps warning
|
|
||||||
* @todo loop detection
|
* @todo loop detection
|
||||||
* @todo console error
|
* @todo console error
|
||||||
*/
|
*/
|
||||||
async #generateObservations(stepCount: number): Promise<void> {
|
async #handleObservations(step: number): Promise<void> {
|
||||||
|
// Accumulated wait time warning
|
||||||
|
if (this.#states.totalWaitTime >= 3) {
|
||||||
|
this.pushObservation(
|
||||||
|
`You have waited ${this.#states.totalWaitTime} seconds accumulatively. ` +
|
||||||
|
`DO NOT wait any longer unless you have a good reason.`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
// Detect URL change
|
// Detect URL change
|
||||||
const currentURL = await this.pageController.getCurrentUrl()
|
const currentURL = this.#states.browserState?.url || ''
|
||||||
if (currentURL !== this.states.lastURL) {
|
if (currentURL !== this.#states.lastURL) {
|
||||||
this.pushObservation(`Page navigated to → ${currentURL}`)
|
this.pushObservation(`Page navigated to → ${currentURL}`)
|
||||||
this.states.lastURL = currentURL
|
this.#states.lastURL = currentURL
|
||||||
await waitFor(0.5) // wait for page to stabilize
|
await waitFor(0.5) // wait for page to stabilize
|
||||||
}
|
}
|
||||||
|
|
||||||
// Warn about remaining steps
|
// Remaining steps warning
|
||||||
const remaining = this.config.maxSteps - stepCount
|
const remaining = this.config.maxSteps - step
|
||||||
if (remaining === 5) {
|
if (remaining === 5) {
|
||||||
this.pushObservation(
|
this.pushObservation(
|
||||||
`⚠️ Only ${remaining} steps remaining. Consider wrapping up or calling done with partial results.`
|
`⚠️ Only ${remaining} steps remaining. ` +
|
||||||
|
`Consider wrapping up or calling done with partial results.`
|
||||||
)
|
)
|
||||||
} else if (remaining === 2) {
|
} else if (remaining === 2) {
|
||||||
this.pushObservation(
|
this.pushObservation(
|
||||||
`⚠️ Critical: Only ${remaining} steps left! You must finish the task or call done immediately.`
|
`⚠️ Critical: Only ${remaining} steps left! You must finish the task or call done immediately.`
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Push observations to history and emit
|
||||||
|
if (this.#observations.length > 0) {
|
||||||
|
for (const content of this.#observations) {
|
||||||
|
this.history.push({ type: 'observation', content })
|
||||||
|
console.log(chalk.cyan('Observation:'), content)
|
||||||
|
}
|
||||||
|
this.#observations = []
|
||||||
|
this.#emitHistoryChange()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async #assembleUserPrompt(): Promise<string> {
|
async #assembleUserPrompt(): Promise<string> {
|
||||||
|
const browserState = this.#states.browserState!
|
||||||
|
|
||||||
let prompt = ''
|
let prompt = ''
|
||||||
|
|
||||||
// <instructions> (optional)
|
// <instructions> (optional)
|
||||||
|
|
||||||
prompt += await this.#getInstructions()
|
prompt += await this.#getInstructions()
|
||||||
|
|
||||||
// <agent_state>
|
// <agent_state>
|
||||||
@@ -506,38 +565,36 @@ export class PageAgentCore extends EventTarget {
|
|||||||
|
|
||||||
const stepCount = this.history.filter((e) => e.type === 'step').length
|
const stepCount = this.history.filter((e) => e.type === 'step').length
|
||||||
|
|
||||||
prompt += `<agent_state>
|
prompt += '<agent_state>\n'
|
||||||
<user_request>
|
prompt += '<user_request>\n'
|
||||||
${this.task}
|
prompt += `${this.task}\n`
|
||||||
</user_request>
|
prompt += '</user_request>\n'
|
||||||
<step_info>
|
prompt += '<step_info>\n'
|
||||||
Step ${stepCount + 1} of ${this.config.maxSteps} max possible steps
|
prompt += `Step ${stepCount + 1} of ${this.config.maxSteps} max possible steps\n`
|
||||||
Current date and time: ${new Date().toLocaleString()}
|
prompt += `Current time: ${new Date().toLocaleString()}\n`
|
||||||
</step_info>
|
prompt += '</step_info>\n'
|
||||||
</agent_state>
|
prompt += '</agent_state>\n\n'
|
||||||
`
|
|
||||||
|
|
||||||
// <agent_history>
|
// <agent_history>
|
||||||
// - <step_N> for steps
|
// - <step_N> for steps
|
||||||
// - <sys> for observations and system messages
|
// - <sys> for observations and system messages
|
||||||
|
|
||||||
prompt += '\n<agent_history>\n'
|
prompt += '<agent_history>\n'
|
||||||
|
|
||||||
let stepIndex = 0
|
let stepIndex = 0
|
||||||
for (const event of this.history) {
|
for (const event of this.history) {
|
||||||
if (event.type === 'step') {
|
if (event.type === 'step') {
|
||||||
stepIndex++
|
stepIndex++
|
||||||
prompt += `<step_${stepIndex}>
|
prompt += `<step_${stepIndex}>\n`
|
||||||
Evaluation of Previous Step: ${event.reflection.evaluation_previous_goal}
|
prompt += `Evaluation of Previous Step: ${event.reflection.evaluation_previous_goal}\n`
|
||||||
Memory: ${event.reflection.memory}
|
prompt += `Memory: ${event.reflection.memory}\n`
|
||||||
Next Goal: ${event.reflection.next_goal}
|
prompt += `Next Goal: ${event.reflection.next_goal}\n`
|
||||||
Action Results: ${event.action.output}
|
prompt += `Action Results: ${event.action.output}\n`
|
||||||
</step_${stepIndex}>
|
prompt += `</step_${stepIndex}>\n`
|
||||||
`
|
|
||||||
} else if (event.type === 'observation') {
|
} else if (event.type === 'observation') {
|
||||||
prompt += `<sys>${event.content}</sys>\n`
|
prompt += `<sys>${event.content}</sys>\n`
|
||||||
} else if (event.type === 'user_takeover') {
|
} else if (event.type === 'user_takeover') {
|
||||||
prompt += `<sys>User took over control and made changes to the page.</sys>\n`
|
prompt += `<sys>User took over control and made changes to the page</sys>\n`
|
||||||
} else if (event.type === 'error') {
|
} else if (event.type === 'error') {
|
||||||
// Error events are mainly for panel rendering, not included in LLM context
|
// Error events are mainly for panel rendering, not included in LLM context
|
||||||
// to avoid polluting the agent's reasoning with transient errors
|
// to avoid polluting the agent's reasoning with transient errors
|
||||||
@@ -548,9 +605,18 @@ export class PageAgentCore extends EventTarget {
|
|||||||
|
|
||||||
// <browser_state>
|
// <browser_state>
|
||||||
|
|
||||||
prompt += await this.#getBrowserState()
|
let pageContent = browserState.content
|
||||||
|
if (this.config.transformPageContent) {
|
||||||
|
pageContent = await this.config.transformPageContent(pageContent)
|
||||||
|
}
|
||||||
|
|
||||||
return trimLines(prompt)
|
prompt += '<browser_state>\n'
|
||||||
|
prompt += browserState.header + '\n'
|
||||||
|
prompt += pageContent + '\n'
|
||||||
|
prompt += browserState.footer + '\n\n'
|
||||||
|
prompt += '</browser_state>\n\n'
|
||||||
|
|
||||||
|
return prompt
|
||||||
}
|
}
|
||||||
|
|
||||||
#onDone(success = true) {
|
#onDone(success = true) {
|
||||||
@@ -560,25 +626,9 @@ export class PageAgentCore extends EventTarget {
|
|||||||
this.#abortController.abort()
|
this.#abortController.abort()
|
||||||
}
|
}
|
||||||
|
|
||||||
async #getBrowserState(): Promise<string> {
|
|
||||||
const state = await this.pageController.getBrowserState()
|
|
||||||
|
|
||||||
let content = state.content
|
|
||||||
if (this.config.transformPageContent) {
|
|
||||||
content = await this.config.transformPageContent(content)
|
|
||||||
}
|
|
||||||
|
|
||||||
return trimLines(`<browser_state>
|
|
||||||
${state.header}
|
|
||||||
${content}
|
|
||||||
${state.footer}
|
|
||||||
|
|
||||||
</browser_state>
|
|
||||||
`)
|
|
||||||
}
|
|
||||||
|
|
||||||
dispose() {
|
dispose() {
|
||||||
console.log('Disposing PageAgent...')
|
console.log('Disposing PageAgent...')
|
||||||
|
this.disposed = true
|
||||||
this.pageController.dispose()
|
this.pageController.dispose()
|
||||||
// this.history = []
|
// this.history = []
|
||||||
this.#abortController.abort()
|
this.#abortController.abort()
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
export const DEFAULT_MAX_STEPS = 20
|
|
||||||
@@ -1,152 +0,0 @@
|
|||||||
import type { LLMConfig } from '@page-agent/llms'
|
|
||||||
import type { PageControllerConfig } from '@page-agent/page-controller'
|
|
||||||
|
|
||||||
import type { PageAgentCore } from '../PageAgentCore'
|
|
||||||
import type { PageAgentTool } from '../tools'
|
|
||||||
import type { ExecutionResult, HistoricalEvent } from '../types'
|
|
||||||
|
|
||||||
export type { LLMConfig }
|
|
||||||
|
|
||||||
/** Supported UI languages */
|
|
||||||
export type SupportedLanguage = 'en-US' | 'zh-CN'
|
|
||||||
|
|
||||||
export interface AgentConfig {
|
|
||||||
// theme?: 'light' | 'dark'
|
|
||||||
language?: SupportedLanguage
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Maximum number of steps the agent can take per task.
|
|
||||||
* @default 20
|
|
||||||
*/
|
|
||||||
maxSteps?: number
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Custom tools to extend PageAgent capabilities
|
|
||||||
* @experimental
|
|
||||||
* @note You can also override or remove internal tools by using the same name.
|
|
||||||
* @see PageAgentTool
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* // override internal tool
|
|
||||||
* import { tool } from 'page-agent'
|
|
||||||
* const customTools = {
|
|
||||||
* ask_user: tool({
|
|
||||||
* description:
|
|
||||||
* 'Ask the user or parent model a question and wait for their answer. Use this if you need more information or clarification.',
|
|
||||||
* inputSchema: zod.object({
|
|
||||||
* question: zod.string(),
|
|
||||||
* }),
|
|
||||||
* execute: async function (this: PageAgent, input) {
|
|
||||||
* const answer = await do_some_thing(input.question)
|
|
||||||
* return "✅ Received user answer: " + answer
|
|
||||||
* },
|
|
||||||
* })
|
|
||||||
* }
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* // remove internal tool
|
|
||||||
* const customTools = {
|
|
||||||
* ask_user: null // never ask user questions
|
|
||||||
* }
|
|
||||||
*/
|
|
||||||
customTools?: Record<string, PageAgentTool | null>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Instructions to guide the agent's behavior
|
|
||||||
*/
|
|
||||||
instructions?: {
|
|
||||||
/**
|
|
||||||
* Global system-level instructions, applied to all tasks
|
|
||||||
*/
|
|
||||||
system?: string
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Dynamic page-level instructions callback
|
|
||||||
* Called before each step to get instructions for the current page
|
|
||||||
* @param url - Current page URL (window.location.href)
|
|
||||||
* @returns Instructions string, or undefined/null to skip
|
|
||||||
*/
|
|
||||||
getPageInstructions?: (url: string) => string | undefined | null
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Lifecycle hooks for task execution.
|
|
||||||
* @experimental API may change in future versions.
|
|
||||||
*
|
|
||||||
* All hooks receive the agent instance as first parameter.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called before each step execution.
|
|
||||||
* @experimental
|
|
||||||
* @param agent - The PageAgentCore instance
|
|
||||||
* @param stepCount - Current step number (0-indexed)
|
|
||||||
*/
|
|
||||||
onBeforeStep?: (agent: PageAgentCore, stepCount: number) => Promise<void> | void
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called after each step execution.
|
|
||||||
* @experimental
|
|
||||||
* @param agent - The PageAgentCore instance
|
|
||||||
* @param history - Current history of events
|
|
||||||
*/
|
|
||||||
onAfterStep?: (agent: PageAgentCore, history: HistoricalEvent[]) => Promise<void> | void
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called before task execution starts.
|
|
||||||
* @experimental
|
|
||||||
* @param agent - The PageAgentCore instance
|
|
||||||
*/
|
|
||||||
onBeforeTask?: (agent: PageAgentCore) => Promise<void> | void
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called after task execution completes (success or failure).
|
|
||||||
* @experimental
|
|
||||||
* @param agent - The PageAgentCore instance
|
|
||||||
* @param result - The execution result
|
|
||||||
*/
|
|
||||||
onAfterTask?: (agent: PageAgentCore, result: ExecutionResult) => Promise<void> | void
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Called when the agent is disposed.
|
|
||||||
* @experimental
|
|
||||||
* @note This hook can block the disposal process if it's async.
|
|
||||||
* @param agent - The PageAgentCore instance
|
|
||||||
* @param reason - Optional reason for disposal
|
|
||||||
*/
|
|
||||||
onDispose?: (agent: PageAgentCore, reason?: string) => void
|
|
||||||
|
|
||||||
// page behavior hooks
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @experimental
|
|
||||||
* Enable the experimental script execution tool that allows executing generated JavaScript code on the page.
|
|
||||||
* @note Can cause unpredictable side effects.
|
|
||||||
* @note May bypass some safe guards and data-masking mechanisms.
|
|
||||||
*/
|
|
||||||
experimentalScriptExecutionTool?: boolean
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Transform page content before sending to LLM.
|
|
||||||
* Called after DOM extraction and simplification, before LLM invocation.
|
|
||||||
* Use cases: inspect extraction results, modify page info, mask sensitive data.
|
|
||||||
*
|
|
||||||
* @param content - Simplified page content that will be sent to LLM
|
|
||||||
* @returns Transformed content
|
|
||||||
*
|
|
||||||
* @example
|
|
||||||
* // Mask phone numbers
|
|
||||||
* transformPageContent: async (content) => {
|
|
||||||
* return content.replace(/1[3-9]\d{9}/g, '***********')
|
|
||||||
* }
|
|
||||||
*/
|
|
||||||
transformPageContent?: (content: string) => Promise<string> | string
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Completely override the default system prompt.
|
|
||||||
* @experimental Use with caution - incorrect prompts may break agent behavior.
|
|
||||||
*/
|
|
||||||
customSystemPrompt?: string
|
|
||||||
}
|
|
||||||
|
|
||||||
export type PageAgentConfig = LLMConfig & AgentConfig & PageControllerConfig
|
|
||||||
@@ -69,7 +69,7 @@ Strictly follow these rules while using the browser and navigating the web:
|
|||||||
- By default, only elements in the visible viewport are listed. Use scrolling actions if you suspect relevant content is offscreen which you need to interact with. Scroll ONLY if there are more pixels below or above the page.
|
- By default, only elements in the visible viewport are listed. Use scrolling actions if you suspect relevant content is offscreen which you need to interact with. Scroll ONLY if there are more pixels below or above the page.
|
||||||
- You can scroll by a specific number of pages using the num_pages parameter (e.g., 0.5 for half page, 2.0 for two pages).
|
- You can scroll by a specific number of pages using the num_pages parameter (e.g., 0.5 for half page, 2.0 for two pages).
|
||||||
- All the elements that are scrollable are marked with `data-scrollable` attribute. Including the scrollable distance in every directions. You can scroll *the element* in case some area are overflowed.
|
- All the elements that are scrollable are marked with `data-scrollable` attribute. Including the scrollable distance in every directions. You can scroll *the element* in case some area are overflowed.
|
||||||
- If a captcha appears, tell user you can not solve captcha. finished the task and ask user to solve it.
|
- If a captcha appears, tell user you can not solve captcha. Finish the task and ask user to solve it.
|
||||||
- If expected elements are missing, try scrolling, or navigating back.
|
- If expected elements are missing, try scrolling, or navigating back.
|
||||||
- If the page is not fully loaded, use the `wait` action.
|
- If the page is not fully loaded, use the `wait` action.
|
||||||
- Do not repeat one action for more than 3 times unless some conditions changed.
|
- Do not repeat one action for more than 3 times unless some conditions changed.
|
||||||
@@ -87,11 +87,11 @@ Strictly follow these rules while using the browser and navigating the web:
|
|||||||
|
|
||||||
<capability>
|
<capability>
|
||||||
- You can only handle single page app. Do not jump out of current page.
|
- You can only handle single page app. Do not jump out of current page.
|
||||||
- Do not click on link if it will open in a new page (etc. <a target="_blank">)
|
- Do not click on link if it will open in a new page (e.g., <a target="_blank">)
|
||||||
- It is ok to fail the task.
|
- It is ok to fail the task.
|
||||||
- User can be wrong. If the request of user is not achievable, inappropriate or you do not have enough information or tools to achieve it. Tell user to make a better request.
|
- User can be wrong. If the request of user is not achievable, inappropriate or you do not have enough information or tools to achieve it. Tell user to make a better request.
|
||||||
- Webpage can be broken. All webpages or apps have bugs. Some bug will make it hard for your job. It's encouraged to tell user the problem of current page. Your feedbacks (including failing) are valuable for user.
|
- Webpage can be broken. All webpages or apps have bugs. Some bug will make it hard for your job. It's encouraged to tell user the problem of current page. Your feedbacks (including failing) are valuable for user.
|
||||||
- Trying to hard can be harmful. Repeating some action back and forth or pushing for a complex procedure with little knowledge can cause unwanted result and harmful side-effects. User would rather you to complete the task with a fail.
|
- Trying too hard can be harmful. Repeating some action back and forth or pushing for a complex procedure with little knowledge can cause unwanted results and harmful side-effects. User would rather you complete the task with a fail.
|
||||||
- If you do not have knowledge for the current webpage or task. You must require user to give specific instructions and detailed steps.
|
- If you do not have knowledge for the current webpage or task. You must require user to give specific instructions and detailed steps.
|
||||||
</capability>
|
</capability>
|
||||||
|
|
||||||
@@ -128,7 +128,6 @@ Exhibit the following reasoning patterns to successfully achieve the <user_reque
|
|||||||
Here are examples of good output patterns. Use them as reference but never copy them directly.
|
Here are examples of good output patterns. Use them as reference but never copy them directly.
|
||||||
|
|
||||||
<evaluation_examples>
|
<evaluation_examples>
|
||||||
- Positive Examples:
|
|
||||||
"evaluation_previous_goal": "Successfully navigated to the product page and found the target information. Verdict: Success"
|
"evaluation_previous_goal": "Successfully navigated to the product page and found the target information. Verdict: Success"
|
||||||
"evaluation_previous_goal": "Clicked the login button and user authentication form appeared. Verdict: Success"
|
"evaluation_previous_goal": "Clicked the login button and user authentication form appeared. Verdict: Success"
|
||||||
</evaluation_examples>
|
</evaluation_examples>
|
||||||
@@ -139,17 +138,16 @@ Here are examples of good output patterns. Use them as reference but never copy
|
|||||||
|
|
||||||
<next_goal_examples>
|
<next_goal_examples>
|
||||||
"next_goal": "Click on the 'Add to Cart' button to proceed with the purchase flow."
|
"next_goal": "Click on the 'Add to Cart' button to proceed with the purchase flow."
|
||||||
"next_goal": "Extract details from the first item on the page."
|
|
||||||
</next_goal_examples>
|
</next_goal_examples>
|
||||||
</examples>
|
</examples>
|
||||||
|
|
||||||
<output>
|
<output>
|
||||||
You must ALWAYS respond with a valid JSON in this exact format:
|
|
||||||
|
|
||||||
{
|
{
|
||||||
"evaluation_previous_goal": "Concise one-sentence analysis of your last action. Clearly state success, failure, or uncertain.",
|
"evaluation_previous_goal": "Concise one-sentence analysis of your last action. Clearly state success, failure, or uncertain.",
|
||||||
"memory": "1-3 concise sentences of specific memory of this step and overall progress. You should put here everything that will help you track progress in future steps. Like counting pages visited, items found, etc.",
|
"memory": "1-3 concise sentences of specific memory of this step and overall progress. You should put here everything that will help you track progress in future steps. Like counting pages visited, items found, etc.",
|
||||||
"next_goal": "State the next immediate goal and action to achieve it, in one clear sentence."
|
"next_goal": "State the next immediate goal and action to achieve it, in one clear sentence.",
|
||||||
"action":{"action": {// action-specific parameter}}
|
"action":{
|
||||||
|
"Action name": {// Action parameters}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
</output>
|
</output>
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
* Internal tools for PageAgent.
|
* Internal tools for PageAgent.
|
||||||
* @note Adapted from browser-use
|
* @note Adapted from browser-use
|
||||||
*/
|
*/
|
||||||
import zod, { type z } from 'zod'
|
import * as z from 'zod/v4'
|
||||||
|
|
||||||
import type { PageAgentCore } from '../PageAgentCore'
|
import type { PageAgentCore } from '../PageAgentCore'
|
||||||
import { waitFor } from '../utils'
|
import { waitFor } from '../utils'
|
||||||
@@ -31,14 +31,13 @@ tools.set(
|
|||||||
'done',
|
'done',
|
||||||
tool({
|
tool({
|
||||||
description:
|
description:
|
||||||
'Complete task - provide a summary of results for the user. Set success=True if task completed successfully, false otherwise. Text should be your response to the user summarizing results.',
|
'Complete task. Text is your final response to the user — keep it concise unless the user explicitly asks for detail.',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
text: zod.string(),
|
text: z.string(),
|
||||||
success: zod.boolean().default(true),
|
success: z.boolean().default(true),
|
||||||
}),
|
}),
|
||||||
execute: async function (this: PageAgentCore, input) {
|
execute: async function (this: PageAgentCore, input) {
|
||||||
// @note main loop will handle this one
|
// @note main loop will handle this one
|
||||||
// this.onDone(input.text, input.success)
|
|
||||||
return Promise.resolve('Task completed')
|
return Promise.resolve('Task completed')
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
@@ -47,25 +46,17 @@ tools.set(
|
|||||||
tools.set(
|
tools.set(
|
||||||
'wait',
|
'wait',
|
||||||
tool({
|
tool({
|
||||||
description:
|
description: 'Wait for x seconds. Can be used to wait until the page or data is fully loaded.',
|
||||||
'Wait for x seconds. default 1s (max 10 seconds, min 1 second). This can be used to wait until the page or data is fully loaded.',
|
inputSchema: z.object({
|
||||||
inputSchema: zod.object({
|
seconds: z.number().min(1).max(10).default(1),
|
||||||
seconds: zod.number().min(1).max(10).default(1),
|
|
||||||
}),
|
}),
|
||||||
execute: async function (this: PageAgentCore, input) {
|
execute: async function (this: PageAgentCore, input) {
|
||||||
|
// try to subtract LLM calling time from the actual wait time
|
||||||
const lastTimeUpdate = await this.pageController.getLastUpdateTime()
|
const lastTimeUpdate = await this.pageController.getLastUpdateTime()
|
||||||
const actualWaitTime = Math.max(0, input.seconds - (Date.now() - lastTimeUpdate) / 1000)
|
const actualWaitTime = Math.max(0, input.seconds - (Date.now() - lastTimeUpdate) / 1000)
|
||||||
console.log(`actualWaitTime: ${actualWaitTime} seconds`)
|
console.log(`actualWaitTime: ${actualWaitTime} seconds`)
|
||||||
await waitFor(actualWaitTime)
|
await waitFor(actualWaitTime)
|
||||||
|
|
||||||
this.states.totalWaitTime += input.seconds
|
|
||||||
|
|
||||||
if (this.states.totalWaitTime >= 3) {
|
|
||||||
this.pushObservation(
|
|
||||||
`You have waited ${this.states.totalWaitTime} seconds accumulatively. Do NOT wait any longer unless you have a good reason.`
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
return `✅ Waited for ${input.seconds} seconds.`
|
return `✅ Waited for ${input.seconds} seconds.`
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
@@ -76,8 +67,8 @@ tools.set(
|
|||||||
tool({
|
tool({
|
||||||
description:
|
description:
|
||||||
'Ask the user a question and wait for their answer. Use this if you need more information or clarification.',
|
'Ask the user a question and wait for their answer. Use this if you need more information or clarification.',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
question: zod.string(),
|
question: z.string(),
|
||||||
}),
|
}),
|
||||||
execute: async function (this: PageAgentCore, input) {
|
execute: async function (this: PageAgentCore, input) {
|
||||||
if (!this.onAskUser) {
|
if (!this.onAskUser) {
|
||||||
@@ -93,8 +84,8 @@ tools.set(
|
|||||||
'click_element_by_index',
|
'click_element_by_index',
|
||||||
tool({
|
tool({
|
||||||
description: 'Click element by index',
|
description: 'Click element by index',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
index: zod.int().min(0),
|
index: z.int().min(0),
|
||||||
}),
|
}),
|
||||||
execute: async function (this: PageAgentCore, input) {
|
execute: async function (this: PageAgentCore, input) {
|
||||||
const result = await this.pageController.clickElement(input.index)
|
const result = await this.pageController.clickElement(input.index)
|
||||||
@@ -106,10 +97,10 @@ tools.set(
|
|||||||
tools.set(
|
tools.set(
|
||||||
'input_text',
|
'input_text',
|
||||||
tool({
|
tool({
|
||||||
description: 'Click and input text into a input interactive element',
|
description: 'Click and type text into an interactive input element',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
index: zod.int().min(0),
|
index: z.int().min(0),
|
||||||
text: zod.string(),
|
text: z.string(),
|
||||||
}),
|
}),
|
||||||
execute: async function (this: PageAgentCore, input) {
|
execute: async function (this: PageAgentCore, input) {
|
||||||
const result = await this.pageController.inputText(input.index, input.text)
|
const result = await this.pageController.inputText(input.index, input.text)
|
||||||
@@ -123,9 +114,9 @@ tools.set(
|
|||||||
tool({
|
tool({
|
||||||
description:
|
description:
|
||||||
'Select dropdown option for interactive element index by the text of the option you want to select',
|
'Select dropdown option for interactive element index by the text of the option you want to select',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
index: zod.int().min(0),
|
index: z.int().min(0),
|
||||||
text: zod.string(),
|
text: z.string(),
|
||||||
}),
|
}),
|
||||||
execute: async function (this: PageAgentCore, input) {
|
execute: async function (this: PageAgentCore, input) {
|
||||||
const result = await this.pageController.selectOption(input.index, input.text)
|
const result = await this.pageController.selectOption(input.index, input.text)
|
||||||
@@ -141,12 +132,12 @@ tools.set(
|
|||||||
'scroll',
|
'scroll',
|
||||||
tool({
|
tool({
|
||||||
description:
|
description:
|
||||||
'Scroll the page by specified number of pages (set down=True to scroll down, down=False to scroll up, num_pages=number of pages to scroll like 0.5 for half page, 1.0 for one page, etc.). Optional index parameter to scroll within a specific element or its scroll container (works well for dropdowns and custom UI components). Optional pixels parameter to scroll by a specific number of pixels instead of pages.',
|
'Scroll vertically. Without index: scrolls the document. With index: scrolls the container at that index (or its nearest scrollable ancestor). Use index of a data-scrollable element to scroll a specific area.',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
down: zod.boolean().default(true),
|
down: z.boolean().default(true),
|
||||||
num_pages: zod.number().min(0).max(10).optional().default(0.1),
|
num_pages: z.number().min(0).max(10).optional().default(0.1),
|
||||||
pixels: zod.number().int().min(0).optional(),
|
pixels: z.number().int().min(0).optional(),
|
||||||
index: zod.number().int().min(0).optional(),
|
index: z.number().int().min(0).optional(),
|
||||||
}),
|
}),
|
||||||
execute: async function (this: PageAgentCore, input) {
|
execute: async function (this: PageAgentCore, input) {
|
||||||
const result = await this.pageController.scroll({
|
const result = await this.pageController.scroll({
|
||||||
@@ -158,15 +149,18 @@ tools.set(
|
|||||||
})
|
})
|
||||||
)
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo Tables need a dedicated parser to extract structured data. This tool is useless.
|
||||||
|
*/
|
||||||
tools.set(
|
tools.set(
|
||||||
'scroll_horizontally',
|
'scroll_horizontally',
|
||||||
tool({
|
tool({
|
||||||
description:
|
description:
|
||||||
'Scroll the page or element horizontally (set right=True to scroll right, right=False to scroll left, pixels=number of pixels to scroll). Optional index parameter to scroll within a specific element or its scroll container (works well for wide tables).',
|
'Scroll horizontally. Without index: scrolls the document. With index: scrolls the container at that index (or its nearest scrollable ancestor). Use index of a data-scrollable element to scroll a specific area.',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
right: zod.boolean().default(true),
|
right: z.boolean().default(true),
|
||||||
pixels: zod.number().int().min(0),
|
pixels: z.number().int().min(0),
|
||||||
index: zod.number().int().min(0).optional(),
|
index: z.number().int().min(0).optional(),
|
||||||
}),
|
}),
|
||||||
execute: async function (this: PageAgentCore, input) {
|
execute: async function (this: PageAgentCore, input) {
|
||||||
const result = await this.pageController.scrollHorizontally(input)
|
const result = await this.pageController.scrollHorizontally(input)
|
||||||
@@ -180,8 +174,8 @@ tools.set(
|
|||||||
tool({
|
tool({
|
||||||
description:
|
description:
|
||||||
'Execute JavaScript code on the current page. Supports async/await syntax. Use with caution!',
|
'Execute JavaScript code on the current page. Supports async/await syntax. Use with caution!',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
script: zod.string(),
|
script: z.string(),
|
||||||
}),
|
}),
|
||||||
execute: async function (this: PageAgentCore, input) {
|
execute: async function (this: PageAgentCore, input) {
|
||||||
const result = await this.pageController.executeJavascript(input.script)
|
const result = await this.pageController.executeJavascript(input.script)
|
||||||
@@ -190,8 +184,6 @@ tools.set(
|
|||||||
})
|
})
|
||||||
)
|
)
|
||||||
|
|
||||||
// @todo get_dropdown_options
|
|
||||||
// @todo select_dropdown_option
|
|
||||||
// @todo send_keys
|
// @todo send_keys
|
||||||
// @todo upload_file
|
// @todo upload_file
|
||||||
// @todo go_back
|
// @todo go_back
|
||||||
|
|||||||
@@ -1,3 +1,165 @@
|
|||||||
|
import type { LLMConfig } from '@page-agent/llms'
|
||||||
|
|
||||||
|
// @note circular dependency but okay
|
||||||
|
import type { PageAgentCore } from './PageAgentCore'
|
||||||
|
import type { PageAgentTool } from './tools'
|
||||||
|
|
||||||
|
/** Supported UI languages */
|
||||||
|
export type SupportedLanguage = 'en-US' | 'zh-CN'
|
||||||
|
|
||||||
|
export interface AgentConfig extends LLMConfig {
|
||||||
|
language?: SupportedLanguage
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Maximum number of steps the agent can take per task.
|
||||||
|
* @default 40
|
||||||
|
*/
|
||||||
|
maxSteps?: number
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom tools to extend PageAgent capabilities
|
||||||
|
* @experimental
|
||||||
|
* @note You can also override or remove internal tools by using the same name.
|
||||||
|
* @see PageAgentTool
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // override internal tool
|
||||||
|
* import { z } from 'zod/v4'
|
||||||
|
* import { tool } from 'page-agent'
|
||||||
|
* const customTools = {
|
||||||
|
* ask_user: tool({
|
||||||
|
* description:
|
||||||
|
* 'Ask the user or parent model a question and wait for their answer. Use this if you need more information or clarification.',
|
||||||
|
* inputSchema: z.object({
|
||||||
|
* question: z.string(),
|
||||||
|
* }),
|
||||||
|
* execute: async function (this: PageAgent, input) {
|
||||||
|
* const answer = await do_some_thing(input.question)
|
||||||
|
* return "✅ Received user answer: " + answer
|
||||||
|
* },
|
||||||
|
* })
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // remove internal tool
|
||||||
|
* const customTools = {
|
||||||
|
* ask_user: null // never ask user questions
|
||||||
|
* }
|
||||||
|
*/
|
||||||
|
customTools?: Record<string, PageAgentTool | null>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Instructions to guide the agent's behavior
|
||||||
|
*/
|
||||||
|
instructions?: {
|
||||||
|
/**
|
||||||
|
* Global system-level instructions, applied to all tasks
|
||||||
|
*/
|
||||||
|
system?: string
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Dynamic page-level instructions callback
|
||||||
|
* Called before each step to get instructions for the current page
|
||||||
|
* @param url - Current page URL (window.location.href)
|
||||||
|
* @returns Instructions string, or undefined/null to skip
|
||||||
|
*/
|
||||||
|
getPageInstructions?: (url: string) => string | undefined | null
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lifecycle hooks for task execution.
|
||||||
|
* @experimental API may change in future versions.
|
||||||
|
*
|
||||||
|
* All hooks receive the agent instance as first parameter.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called before each step execution.
|
||||||
|
* @experimental
|
||||||
|
* @param agent - The PageAgentCore instance
|
||||||
|
* @param stepCount - Current step number (0-indexed)
|
||||||
|
*/
|
||||||
|
onBeforeStep?: (agent: PageAgentCore, stepCount: number) => Promise<void> | void
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called after each step execution.
|
||||||
|
* @experimental
|
||||||
|
* @param agent - The PageAgentCore instance
|
||||||
|
* @param history - Current history of events
|
||||||
|
*/
|
||||||
|
onAfterStep?: (agent: PageAgentCore, history: HistoricalEvent[]) => Promise<void> | void
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called before task execution starts.
|
||||||
|
* @experimental
|
||||||
|
* @param agent - The PageAgentCore instance
|
||||||
|
*/
|
||||||
|
onBeforeTask?: (agent: PageAgentCore) => Promise<void> | void
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called after task execution completes (success or failure).
|
||||||
|
* @experimental
|
||||||
|
* @param agent - The PageAgentCore instance
|
||||||
|
* @param result - The execution result
|
||||||
|
*/
|
||||||
|
onAfterTask?: (agent: PageAgentCore, result: ExecutionResult) => Promise<void> | void
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called when the agent is disposed.
|
||||||
|
* @experimental
|
||||||
|
* @note This hook can block the disposal process if it's async.
|
||||||
|
* @param agent - The PageAgentCore instance
|
||||||
|
* @param reason - Optional reason for disposal
|
||||||
|
*/
|
||||||
|
onDispose?: (agent: PageAgentCore, reason?: string) => void
|
||||||
|
|
||||||
|
// page behavior hooks
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @experimental
|
||||||
|
* Enable the experimental script execution tool that allows executing generated JavaScript code on the page.
|
||||||
|
* @note Can cause unpredictable side effects.
|
||||||
|
* @note May bypass some safe guards and data-masking mechanisms.
|
||||||
|
*/
|
||||||
|
experimentalScriptExecutionTool?: boolean
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @experimental
|
||||||
|
* Fetch /llms.txt from current site origin and include as context.
|
||||||
|
* Only fetched once per origin per task.
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
experimentalLlmsTxt?: boolean
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Transform page content before sending to LLM.
|
||||||
|
* Called after DOM extraction and simplification, before LLM invocation.
|
||||||
|
* Use cases: inspect extraction results, modify page info, mask sensitive data.
|
||||||
|
*
|
||||||
|
* @param content - Simplified page content that will be sent to LLM
|
||||||
|
* @returns Transformed content
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* // Mask phone numbers
|
||||||
|
* transformPageContent: async (content) => {
|
||||||
|
* return content.replace(/1[3-9]\d{9}/g, '***********')
|
||||||
|
* }
|
||||||
|
*/
|
||||||
|
transformPageContent?: (content: string) => Promise<string> | string
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Completely override the default system prompt.
|
||||||
|
* @experimental Use with caution - incorrect prompts may break agent behavior.
|
||||||
|
*/
|
||||||
|
customSystemPrompt?: string
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delay between steps in seconds.
|
||||||
|
* @default 0.4
|
||||||
|
*/
|
||||||
|
stepDelay?: number
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Agent reflection state - the reflection-before-action model
|
* Agent reflection state - the reflection-before-action model
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,17 +0,0 @@
|
|||||||
import chalk from 'chalk'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Simple assertion function that throws an error if the condition is falsy
|
|
||||||
* @param condition - The condition to assert
|
|
||||||
* @param message - Optional error message
|
|
||||||
* @throws Error if condition is falsy
|
|
||||||
*/
|
|
||||||
export function assert(condition: unknown, message?: string, silent?: boolean): asserts condition {
|
|
||||||
if (!condition) {
|
|
||||||
const errorMessage = message ?? 'Assertion failed'
|
|
||||||
|
|
||||||
if (!silent) console.error(chalk.red(`❌ assert: ${errorMessage}`))
|
|
||||||
|
|
||||||
throw new Error(errorMessage)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,4 +1,10 @@
|
|||||||
|
import { InvokeError, InvokeErrorType } from '@page-agent/llms'
|
||||||
import chalk from 'chalk'
|
import chalk from 'chalk'
|
||||||
|
import * as z from 'zod/v4'
|
||||||
|
|
||||||
|
import type { PageAgentTool } from '../tools'
|
||||||
|
|
||||||
|
const log = console.log.bind(console, chalk.yellow('[autoFixer]'))
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalize LLM response and fix common format issues.
|
* Normalize LLM response and fix common format issues.
|
||||||
@@ -9,10 +15,11 @@ import chalk from 'chalk'
|
|||||||
* - Arguments wrapped as double JSON string
|
* - Arguments wrapped as double JSON string
|
||||||
* - Nested function call format
|
* - Nested function call format
|
||||||
* - Missing action field (fallback to wait)
|
* - Missing action field (fallback to wait)
|
||||||
|
* - Primitive action input for single-field tools (e.g. `{"click_element_by_index": 2}`)
|
||||||
* - etc.
|
* - etc.
|
||||||
*/
|
*/
|
||||||
export function normalizeResponse(response: any): any {
|
export function normalizeResponse(response: any, tools?: Map<string, PageAgentTool>): any {
|
||||||
let resolvedArguments = null as any
|
let resolvedArguments: any
|
||||||
|
|
||||||
const choice = (response as { choices?: Choice[] }).choices?.[0]
|
const choice = (response as { choices?: Choice[] }).choices?.[0]
|
||||||
if (!choice) throw new Error('No choices in response')
|
if (!choice) throw new Error('No choices in response')
|
||||||
@@ -29,7 +36,7 @@ export function normalizeResponse(response: any): any {
|
|||||||
|
|
||||||
// case: sometimes the model only returns the action level
|
// case: sometimes the model only returns the action level
|
||||||
if (toolCall.function.name && toolCall.function.name !== 'AgentOutput') {
|
if (toolCall.function.name && toolCall.function.name !== 'AgentOutput') {
|
||||||
console.log(chalk.yellow(`[normalizeResponse] #1: fixing tool_call`))
|
log(`#1: fixing tool_call`)
|
||||||
resolvedArguments = { action: safeJsonParse(resolvedArguments) }
|
resolvedArguments = { action: safeJsonParse(resolvedArguments) }
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
@@ -42,13 +49,13 @@ export function normalizeResponse(response: any): any {
|
|||||||
|
|
||||||
// case: sometimes the content json includes upper level wrapper
|
// case: sometimes the content json includes upper level wrapper
|
||||||
if (resolvedArguments?.name === 'AgentOutput') {
|
if (resolvedArguments?.name === 'AgentOutput') {
|
||||||
console.log(chalk.yellow(`[normalizeResponse] #2: fixing tool_call`))
|
log(`#2: fixing tool_call`)
|
||||||
resolvedArguments = safeJsonParse(resolvedArguments.arguments)
|
resolvedArguments = safeJsonParse(resolvedArguments.arguments)
|
||||||
}
|
}
|
||||||
|
|
||||||
// case: sometimes even 2-levels of wrapping
|
// case: sometimes even 2-levels of wrapping
|
||||||
if (resolvedArguments?.type === 'function') {
|
if (resolvedArguments?.type === 'function') {
|
||||||
console.log(chalk.yellow(`[normalizeResponse] #3: fixing tool_call`))
|
log(`#3: fixing tool_call`)
|
||||||
resolvedArguments = safeJsonParse(resolvedArguments.function.arguments)
|
resolvedArguments = safeJsonParse(resolvedArguments.function.arguments)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -61,7 +68,7 @@ export function normalizeResponse(response: any): any {
|
|||||||
!resolvedArguments?.next_goal &&
|
!resolvedArguments?.next_goal &&
|
||||||
!resolvedArguments?.thinking
|
!resolvedArguments?.thinking
|
||||||
) {
|
) {
|
||||||
console.log(chalk.yellow(`[normalizeResponse] #4: fixing tool_call`))
|
log(`#4: fixing tool_call`)
|
||||||
resolvedArguments = { action: safeJsonParse(resolvedArguments) }
|
resolvedArguments = { action: safeJsonParse(resolvedArguments) }
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
@@ -78,10 +85,15 @@ export function normalizeResponse(response: any): any {
|
|||||||
resolvedArguments.action = safeJsonParse(resolvedArguments.action)
|
resolvedArguments.action = safeJsonParse(resolvedArguments.action)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// validate and fix action input using tool schemas
|
||||||
|
if (resolvedArguments.action && tools) {
|
||||||
|
resolvedArguments.action = validateAction(resolvedArguments.action, tools)
|
||||||
|
}
|
||||||
|
|
||||||
// fix incomplete formats
|
// fix incomplete formats
|
||||||
if (!resolvedArguments.action) {
|
if (!resolvedArguments.action) {
|
||||||
console.log(chalk.yellow(`[normalizeResponse] #5: fixing tool_call`))
|
log(`#5: fixing tool_call`)
|
||||||
resolvedArguments.action = { name: 'wait', input: { seconds: 1 } }
|
resolvedArguments.action = { wait: { seconds: 1 } }
|
||||||
}
|
}
|
||||||
|
|
||||||
// pack back to standard format
|
// pack back to standard format
|
||||||
@@ -108,6 +120,53 @@ export function normalizeResponse(response: any): any {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validate action against tool schemas. Provides clear error messages
|
||||||
|
* instead of letting the union schema produce unreadable errors.
|
||||||
|
*
|
||||||
|
* Also coerces primitive inputs for single-field tools:
|
||||||
|
* e.g. `{"click_element_by_index": 2}` → `{"click_element_by_index": {"index": 2}}`
|
||||||
|
*/
|
||||||
|
function validateAction(action: any, tools: Map<string, PageAgentTool>): any {
|
||||||
|
if (typeof action !== 'object' || action === null) return action
|
||||||
|
|
||||||
|
const toolName = Object.keys(action)[0]
|
||||||
|
if (!toolName) return action
|
||||||
|
|
||||||
|
const tool = tools.get(toolName)
|
||||||
|
if (!tool) {
|
||||||
|
const available = Array.from(tools.keys()).join(', ')
|
||||||
|
throw new InvokeError(
|
||||||
|
InvokeErrorType.INVALID_TOOL_ARGS,
|
||||||
|
`Unknown action "${toolName}". Available: ${available}`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
let value = action[toolName]
|
||||||
|
const schema = tool.inputSchema
|
||||||
|
|
||||||
|
// coerce primitive input for single-field tools
|
||||||
|
if (schema instanceof z.ZodObject && value !== null && typeof value !== 'object') {
|
||||||
|
const requiredKey = Object.keys(schema.shape).find(
|
||||||
|
(k) => !(schema.shape as Record<string, z.ZodType>)[k].safeParse(undefined).success
|
||||||
|
)
|
||||||
|
if (requiredKey) {
|
||||||
|
log(`coercing primitive action input for "${toolName}"`)
|
||||||
|
value = { [requiredKey]: value }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = schema.safeParse(value)
|
||||||
|
if (!result.success) {
|
||||||
|
throw new InvokeError(
|
||||||
|
InvokeErrorType.INVALID_TOOL_ARGS,
|
||||||
|
`Invalid input for action "${toolName}": ${z.prettifyError(result.error)}`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return { [toolName]: result.data }
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Safely parse JSON, return original input if not json.
|
* Safely parse JSON, return original input if not json.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -1,26 +1,6 @@
|
|||||||
export { normalizeResponse } from './autoFixer'
|
import chalk from 'chalk'
|
||||||
|
|
||||||
/**
|
export * from './autoFixer'
|
||||||
* Wait until condition becomes true
|
|
||||||
* @returns Returns when condition becomes true, throws otherwise
|
|
||||||
* @param timeout Timeout in milliseconds, default 0 means no timeout, throws error on timeout
|
|
||||||
*/
|
|
||||||
export async function waitUntil(check: () => boolean, timeout = 60 * 60_1000): Promise<boolean> {
|
|
||||||
if (check()) return true
|
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
const start = Date.now()
|
|
||||||
const interval = setInterval(() => {
|
|
||||||
if (check()) {
|
|
||||||
clearInterval(interval)
|
|
||||||
resolve(true)
|
|
||||||
} else if (Date.now() - start > timeout) {
|
|
||||||
clearInterval(interval)
|
|
||||||
reject(new Error('Timeout waiting for condition to become true'))
|
|
||||||
}
|
|
||||||
}, 100)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function waitFor(seconds: number): Promise<void> {
|
export async function waitFor(seconds: number): Promise<void> {
|
||||||
await new Promise((resolve) => setTimeout(resolve, seconds * 1000))
|
await new Promise((resolve) => setTimeout(resolve, seconds * 1000))
|
||||||
@@ -37,15 +17,6 @@ export function truncate(text: string, maxLength: number): string {
|
|||||||
|
|
||||||
//
|
//
|
||||||
|
|
||||||
export function trimLines(text: string): string {
|
|
||||||
return text
|
|
||||||
.split('\n')
|
|
||||||
.map((line) => line.trim())
|
|
||||||
.join('\n')
|
|
||||||
}
|
|
||||||
|
|
||||||
//
|
|
||||||
|
|
||||||
export function randomID(existingIDs?: string[]): string {
|
export function randomID(existingIDs?: string[]): string {
|
||||||
let id = Math.random().toString(36).substring(2, 11)
|
let id = Math.random().toString(36).substring(2, 11)
|
||||||
|
|
||||||
@@ -60,7 +31,7 @@ export function randomID(existingIDs?: string[]): string {
|
|||||||
id = Math.random().toString(36).substring(2, 11)
|
id = Math.random().toString(36).substring(2, 11)
|
||||||
tryCount++
|
tryCount++
|
||||||
if (tryCount > MAX_TRY) {
|
if (tryCount > MAX_TRY) {
|
||||||
throw new Error('randomID: too many try')
|
throw new Error('randomID: too many tries')
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -85,3 +56,56 @@ export function uid() {
|
|||||||
ids.push(id)
|
ids.push(id)
|
||||||
return id
|
return id
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const llmsTxtCache = new Map<string, string | null>()
|
||||||
|
|
||||||
|
/** Fetch /llms.txt for a URL's origin. Cached per origin, `null` = tried and not found. */
|
||||||
|
export async function fetchLlmsTxt(url: string): Promise<string | null> {
|
||||||
|
let origin: string
|
||||||
|
try {
|
||||||
|
origin = new URL(url).origin
|
||||||
|
} catch {
|
||||||
|
return null // Invalid URL
|
||||||
|
}
|
||||||
|
// about:blank, data:, file:
|
||||||
|
if (origin === 'null') return null
|
||||||
|
|
||||||
|
if (llmsTxtCache.has(origin)) return llmsTxtCache.get(origin)!
|
||||||
|
|
||||||
|
const endpoint = `${origin}/llms.txt`
|
||||||
|
let result: string | null = null
|
||||||
|
try {
|
||||||
|
console.log(chalk.gray(`[llms.txt] Fetching ${endpoint}`))
|
||||||
|
const res = await fetch(endpoint, { signal: AbortSignal.timeout(3000) })
|
||||||
|
if (res.ok) {
|
||||||
|
result = await res.text()
|
||||||
|
console.log(chalk.green(`[llms.txt] Found (${result.length} chars)`))
|
||||||
|
if (result.length > 1000) {
|
||||||
|
console.log(chalk.yellow(`[llms.txt] Truncating to 1000 chars`))
|
||||||
|
result = truncate(result, 1000)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
console.debug(chalk.gray(`[llms.txt] ${res.status} for ${endpoint}`))
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
console.debug(chalk.gray(`[llms.txt] not found for ${endpoint}`), e)
|
||||||
|
}
|
||||||
|
llmsTxtCache.set(origin, result)
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Simple assertion function that throws an error if the condition is falsy
|
||||||
|
* @param condition - The condition to assert
|
||||||
|
* @param message - Optional error message
|
||||||
|
* @throws Error if condition is falsy
|
||||||
|
*/
|
||||||
|
export function assert(condition: unknown, message?: string, silent?: boolean): asserts condition {
|
||||||
|
if (!condition) {
|
||||||
|
const errorMessage = message ?? 'Assertion failed'
|
||||||
|
|
||||||
|
if (!silent) console.error(chalk.red(`❌ assert: ${errorMessage}`))
|
||||||
|
|
||||||
|
throw new Error(errorMessage)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "./tsconfig.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
// @workaround DTS bug
|
|
||||||
// dts do not work with monorepo path mapping
|
|
||||||
// disable path mapping for it
|
|
||||||
"paths": {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,22 +1,8 @@
|
|||||||
{
|
{
|
||||||
"extends": "../../tsconfig.base.json",
|
"extends": "../../tsconfig.base.json",
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.tsbuildinfo",
|
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.tsbuildinfo"
|
||||||
"noEmit": false,
|
|
||||||
"allowImportingTsExtensions": false,
|
|
||||||
"baseUrl": ".",
|
|
||||||
"outDir": "dist",
|
|
||||||
"paths": {
|
|
||||||
//
|
|
||||||
"@page-agent/llms": ["../llms/src/index.ts"],
|
|
||||||
"@page-agent/page-controller": ["../page-controller/src/PageController.ts"]
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"include": ["**/*.ts"],
|
"include": ["src/**/*.ts"],
|
||||||
"exclude": ["dist", "node_modules"],
|
"exclude": ["dist", "node_modules"]
|
||||||
"references": [
|
|
||||||
//
|
|
||||||
{ "path": "../llms" },
|
|
||||||
{ "path": "../page-controller" }
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,13 +11,18 @@ const __dirname = dirname(fileURLToPath(import.meta.url))
|
|||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
clearScreen: false,
|
clearScreen: false,
|
||||||
plugins: [
|
plugins: [
|
||||||
dts({ tsconfigPath: './tsconfig.dts.json', bundleTypes: true }),
|
dts({
|
||||||
|
bundleTypes: true,
|
||||||
|
compilerOptions: {
|
||||||
|
composite: true,
|
||||||
|
noEmit: false,
|
||||||
|
emitDeclarationOnly: true,
|
||||||
|
declaration: true,
|
||||||
|
},
|
||||||
|
}),
|
||||||
cssInjectedByJsPlugin({ relativeCSSInjection: true }),
|
cssInjectedByJsPlugin({ relativeCSSInjection: true }),
|
||||||
],
|
],
|
||||||
publicDir: false,
|
publicDir: false,
|
||||||
esbuild: {
|
|
||||||
keepNames: true,
|
|
||||||
},
|
|
||||||
build: {
|
build: {
|
||||||
lib: {
|
lib: {
|
||||||
entry: resolve(__dirname, 'src/PageAgentCore.ts'),
|
entry: resolve(__dirname, 'src/PageAgentCore.ts'),
|
||||||
@@ -30,6 +35,7 @@ export default defineConfig({
|
|||||||
external: [
|
external: [
|
||||||
'chalk',
|
'chalk',
|
||||||
'zod',
|
'zod',
|
||||||
|
'zod/v4',
|
||||||
// all the internal packages
|
// all the internal packages
|
||||||
/^@page-agent\//,
|
/^@page-agent\//,
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -1,57 +1,5 @@
|
|||||||
# Privacy Policy for Page Agent Extension
|
# Privacy Policy for Page Agent Extension
|
||||||
|
|
||||||
**Last updated:** January 2026
|
This document has moved. Please see our full **[Terms of Use & Privacy](../../docs/terms-and-privacy.md)**.
|
||||||
|
|
||||||
## Overview
|
Online: https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md
|
||||||
|
|
||||||
Page Agent Extension is a browser automation tool that uses AI to help you interact with web pages. This policy explains what data is processed and under what circumstances.
|
|
||||||
|
|
||||||
## Data Processing
|
|
||||||
|
|
||||||
### Local Processing
|
|
||||||
|
|
||||||
The extension performs DOM analysis and automation actions **locally in your browser**. Your browsing history, passwords, and form data are not accessed or collected by the extension itself.
|
|
||||||
|
|
||||||
### Data Transmission
|
|
||||||
|
|
||||||
Data is transmitted to external servers **only when you initiate an automation task**. When this occurs:
|
|
||||||
|
|
||||||
- Your task instructions (natural language commands)
|
|
||||||
- Sanitized page structure (simplified DOM, excluding sensitive form values)
|
|
||||||
|
|
||||||
are sent to the LLM API endpoint configured in **your settings**.
|
|
||||||
|
|
||||||
**If you configure a third-party LLM provider** (e.g., OpenAI, Anthropic, or others), data is sent directly to that provider. Their privacy policies apply.
|
|
||||||
|
|
||||||
**If you use our testing endpoint**, your requests are proxied to [DeepSeek](https://deepseek.com) for AI processing. Regarding this test endpoint:
|
|
||||||
|
|
||||||
- This endpoint is provided for evaluation purposes only and is not recommended for production or daily use
|
|
||||||
- We do **not** store your task content, page content, or visited URLs
|
|
||||||
- Minimal logging (timestamps, request metadata, IP addresses) may occur for abuse prevention and service stability
|
|
||||||
- DeepSeek's [Privacy Policy](https://cdn.deepseek.com/policies/en-US/deepseek-privacy-policy.html) applies to their processing of your requests
|
|
||||||
|
|
||||||
## Data Storage
|
|
||||||
|
|
||||||
- **Local storage only**: Your configuration (API endpoint, API key, model selection) is stored in your browser via `chrome.storage.local`
|
|
||||||
- **No cloud sync**: Configuration is not synced to any external server
|
|
||||||
- **No analytics**: The extension does not include any analytics or tracking code
|
|
||||||
|
|
||||||
## Your Control
|
|
||||||
|
|
||||||
- The extension is open source and can be audited by anyone
|
|
||||||
- You choose which LLM provider to use
|
|
||||||
- You may configure your own API endpoint at any time
|
|
||||||
- You can clear all stored data by removing the extension
|
|
||||||
|
|
||||||
## Changes to This Policy
|
|
||||||
|
|
||||||
We may update this policy as the extension evolves. Significant changes will be noted in the extension's release notes.
|
|
||||||
|
|
||||||
## Contact
|
|
||||||
|
|
||||||
For questions about this privacy policy:
|
|
||||||
https://github.com/alibaba/page-agent/issues
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Source code: https://github.com/alibaba/page-agent
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
"tsx": true,
|
"tsx": true,
|
||||||
"tailwind": {
|
"tailwind": {
|
||||||
"config": "",
|
"config": "",
|
||||||
"css": "src/index.css",
|
"css": "src/assets/index.css",
|
||||||
"baseColor": "neutral",
|
"baseColor": "neutral",
|
||||||
"cssVariables": true,
|
"cssVariables": true,
|
||||||
"prefix": ""
|
"prefix": ""
|
||||||
@@ -16,7 +16,7 @@
|
|||||||
"utils": "@/lib/utils",
|
"utils": "@/lib/utils",
|
||||||
"ui": "@/components/ui",
|
"ui": "@/components/ui",
|
||||||
"lib": "@/lib",
|
"lib": "@/lib",
|
||||||
"hooks": "@/hooks"
|
"hooks": "@/lib/hooks"
|
||||||
},
|
},
|
||||||
"registries": {
|
"registries": {
|
||||||
"@magicui": "https://magicui.design/r/{name}.json"
|
"@magicui": "https://magicui.design/r/{name}.json"
|
||||||
|
|||||||
@@ -1,12 +1,18 @@
|
|||||||
# Page Agent Extension API
|
# Page Agent Extension API
|
||||||
|
|
||||||
This document describes how to integrate the Page Agent browser extension into your web application.
|
Integrate the Page Agent extension into your web app and trigger multi-page browser tasks from page JavaScript.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### 1. Install the browser extension
|
### 1. Install the browser extension
|
||||||
|
|
||||||
Install the Page Agent extension from the Chrome Web Store.
|
Primary channel:
|
||||||
|
|
||||||
|
- Chrome Web Store: https://chromewebstore.google.com/detail/page-agent-ext/akldabonmimlicnjlflnapfeklbfemhj
|
||||||
|
|
||||||
|
Latest updates are often published earlier on:
|
||||||
|
|
||||||
|
- GitHub Releases: https://github.com/alibaba/page-agent/releases
|
||||||
|
|
||||||
### 2. Install type definitions (recommended)
|
### 2. Install type definitions (recommended)
|
||||||
|
|
||||||
@@ -14,11 +20,19 @@ Install the Page Agent extension from the Chrome Web Store.
|
|||||||
npm install @page-agent/core --save-dev
|
npm install @page-agent/core --save-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Set up authentication
|
### 3. Authorization (Token)
|
||||||
|
|
||||||
The extension only injects APIs when it detects a valid token in `localStorage`.
|
The token allows your page JS to call the extension API (`window.PAGE_AGENT_EXT`) and execute multi-page tasks.
|
||||||
|
|
||||||
1. Open the extension's side panel to get your authorization token
|
Why token-based access is required:
|
||||||
|
|
||||||
|
- The extension has broad browser permissions (page access, navigation, multi-tab control).
|
||||||
|
- If abused, it can harm user privacy and security.
|
||||||
|
- Users must explicitly provide the token only to applications they trust.
|
||||||
|
|
||||||
|
Setup:
|
||||||
|
|
||||||
|
1. Open the extension side panel and copy your auth token.
|
||||||
2. Set the token in your page:
|
2. Set the token in your page:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@@ -33,7 +47,6 @@ import type {
|
|||||||
AgentStatus,
|
AgentStatus,
|
||||||
ExecutionResult,
|
ExecutionResult,
|
||||||
HistoricalEvent,
|
HistoricalEvent,
|
||||||
LLMConfig,
|
|
||||||
} from '@page-agent/core'
|
} from '@page-agent/core'
|
||||||
|
|
||||||
// Wait for extension injection (up to 1 second)
|
// Wait for extension injection (up to 1 second)
|
||||||
@@ -48,55 +61,49 @@ async function waitForExtension(timeout = 1000): Promise<boolean> {
|
|||||||
|
|
||||||
// Usage
|
// Usage
|
||||||
if (await waitForExtension()) {
|
if (await waitForExtension()) {
|
||||||
const result = await window.PAGE_AGENT_EXT!.execute(
|
const result = await window.PAGE_AGENT_EXT!.execute('Click the login button', {
|
||||||
'Click the login button',
|
baseURL: 'https://api.openai.com/v1',
|
||||||
{
|
apiKey: 'your-api-key',
|
||||||
baseURL: 'https://api.openai.com/v1',
|
model: 'gpt-5.2',
|
||||||
apiKey: 'your-api-key',
|
onStatusChange: (status) => console.log('Status:', status),
|
||||||
model: 'gpt-5.2',
|
onActivity: (activity) => console.log('Activity:', activity),
|
||||||
},
|
})
|
||||||
{
|
|
||||||
onStatusChange: (status) => console.log('Status:', status),
|
|
||||||
onActivity: (activity) => console.log('Activity:', activity),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
console.log('Result:', result)
|
console.log('Result:', result)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Global API
|
## Global API
|
||||||
|
|
||||||
The extension injects the following APIs into the `window` object:
|
After token match, the extension injects APIs into `window`.
|
||||||
|
|
||||||
### `window.PAGE_AGENT_EXT_VERSION`
|
### `window.PAGE_AGENT_EXT_VERSION`
|
||||||
|
|
||||||
Extension version string (e.g., `"1.0.0"`). This is exposed separately to allow version checking before accessing the main API object.
|
Extension version string (for capability checks before using the main API).
|
||||||
|
|
||||||
### `window.PAGE_AGENT_EXT`
|
### `window.PAGE_AGENT_EXT`
|
||||||
|
|
||||||
Main API namespace object containing:
|
Main namespace object.
|
||||||
|
|
||||||
#### `PAGE_AGENT_EXT.execute(task, llmConfig, hooks?)`
|
#### `PAGE_AGENT_EXT.execute(task, config)`
|
||||||
|
|
||||||
Execute an agent task.
|
Execute one agent task.
|
||||||
|
|
||||||
**Parameters:**
|
Parameters:
|
||||||
|
|
||||||
| Name | Type | Required | Description |
|
| Name | Type | Required | Description |
|
||||||
|------|------|----------|-------------|
|
| ---- | ---- | -------- | ----------- |
|
||||||
| `task` | `string` | Yes | Task description |
|
| `task` | `string` | Yes | Task description |
|
||||||
| `llmConfig` | `LLMConfig` | Yes | LLM configuration |
|
| `config` | `ExecuteConfig` | Yes | LLM settings, options, and callbacks |
|
||||||
| `hooks` | `ExecuteHooks` | No | Event callbacks |
|
|
||||||
|
|
||||||
**Returns:** `Promise<ExecutionResult>`
|
Returns: `Promise<ExecutionResult>`
|
||||||
|
|
||||||
#### `PAGE_AGENT_EXT.dispose()`
|
#### `PAGE_AGENT_EXT.stop()`
|
||||||
|
|
||||||
Stop and destroy the current running agent.
|
Stop the current task.
|
||||||
|
|
||||||
## Types
|
## Types
|
||||||
|
|
||||||
Install `@page-agent/core` for full type definitions:
|
Install `@page-agent/core` for complete types:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import type {
|
import type {
|
||||||
@@ -104,37 +111,40 @@ import type {
|
|||||||
AgentStatus,
|
AgentStatus,
|
||||||
ExecutionResult,
|
ExecutionResult,
|
||||||
HistoricalEvent,
|
HistoricalEvent,
|
||||||
LLMConfig,
|
|
||||||
} from '@page-agent/core'
|
} from '@page-agent/core'
|
||||||
|
|
||||||
export interface ExecuteHooks {
|
export interface ExecuteConfig {
|
||||||
|
baseURL: string
|
||||||
|
model: string
|
||||||
|
apiKey?: string
|
||||||
|
|
||||||
|
// Global system-level instructions for the agent.
|
||||||
|
// Equivalent to AgentConfig.instructions.system.
|
||||||
|
systemInstruction?: string
|
||||||
|
|
||||||
|
// Include the initial tab where page JS starts. Default: true.
|
||||||
|
includeInitialTab?: boolean
|
||||||
|
|
||||||
|
// Control all unpinned tabs in the window instead of only the tab group.
|
||||||
|
// When enabled, agent sees and can switch to every non-pinned tab.
|
||||||
|
// Default: false. Experimental.
|
||||||
|
experimentalIncludeAllTabs?: boolean
|
||||||
|
|
||||||
onStatusChange?: (status: AgentStatus) => void
|
onStatusChange?: (status: AgentStatus) => void
|
||||||
onActivity?: (activity: AgentActivity) => void
|
onActivity?: (activity: AgentActivity) => void
|
||||||
onHistoryUpdate?: (history: HistoricalEvent[]) => void
|
onHistoryUpdate?: (history: HistoricalEvent[]) => void
|
||||||
onDispose?: () => void
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export type Execute = (
|
export type Execute = (task: string, config: ExecuteConfig) => Promise<ExecutionResult>
|
||||||
task: string,
|
|
||||||
llmConfig: LLMConfig,
|
|
||||||
hooks?: ExecuteHooks
|
|
||||||
) => Promise<ExecutionResult>
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### AgentStatus
|
`AgentStatus`
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
type AgentStatus = 'idle' | 'running' | 'completed' | 'error'
|
type AgentStatus = 'idle' | 'running' | 'completed' | 'error'
|
||||||
```
|
```
|
||||||
|
|
||||||
| Status | Description |
|
`AgentActivity`
|
||||||
|--------|-------------|
|
|
||||||
| `idle` | Agent is idle, ready to execute |
|
|
||||||
| `running` | Agent is executing a task |
|
|
||||||
| `completed` | Task completed successfully |
|
|
||||||
| `error` | Task failed with an error |
|
|
||||||
|
|
||||||
### AgentActivity
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
type AgentActivity =
|
type AgentActivity =
|
||||||
@@ -145,15 +155,7 @@ type AgentActivity =
|
|||||||
| { type: 'error'; message: string }
|
| { type: 'error'; message: string }
|
||||||
```
|
```
|
||||||
|
|
||||||
| Type | Description |
|
`HistoricalEvent`
|
||||||
|------|-------------|
|
|
||||||
| `thinking` | Agent is analyzing the page and planning |
|
|
||||||
| `executing` | Agent is executing a tool action |
|
|
||||||
| `executed` | Tool execution completed |
|
|
||||||
| `retrying` | Retrying after a failure |
|
|
||||||
| `error` | An error occurred |
|
|
||||||
|
|
||||||
### HistoricalEvent
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
type HistoricalEvent =
|
type HistoricalEvent =
|
||||||
@@ -164,17 +166,7 @@ type HistoricalEvent =
|
|||||||
| { type: 'error'; message: string; rawResponse?: unknown }
|
| { type: 'error'; message: string; rawResponse?: unknown }
|
||||||
```
|
```
|
||||||
|
|
||||||
### LLMConfig
|
`ExecutionResult`
|
||||||
|
|
||||||
```typescript
|
|
||||||
interface LLMConfig {
|
|
||||||
baseURL: string // e.g. 'https://api.openai.com/v1'
|
|
||||||
apiKey: string
|
|
||||||
model: string // e.g. 'gpt-5.2'
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### ExecutionResult
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
interface ExecutionResult {
|
interface ExecutionResult {
|
||||||
@@ -195,62 +187,22 @@ const result = await window.PAGE_AGENT_EXT!.execute(
|
|||||||
baseURL: 'https://api.openai.com/v1',
|
baseURL: 'https://api.openai.com/v1',
|
||||||
apiKey: process.env.OPENAI_API_KEY!,
|
apiKey: process.env.OPENAI_API_KEY!,
|
||||||
model: 'gpt-5.2',
|
model: 'gpt-5.2',
|
||||||
}
|
includeInitialTab: false, // Optional: exclude current tab
|
||||||
)
|
onStatusChange: (status) => console.log(status),
|
||||||
|
onActivity: (activity) => console.log(activity),
|
||||||
if (result.success) {
|
|
||||||
console.log('Task completed:', result.data)
|
|
||||||
} else {
|
|
||||||
console.error('Task failed')
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### With Event Hooks
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
await window.PAGE_AGENT_EXT!.execute(
|
|
||||||
'Navigate to the settings page',
|
|
||||||
llmConfig,
|
|
||||||
{
|
|
||||||
onStatusChange: (status) => {
|
|
||||||
updateUI({ agentStatus: status })
|
|
||||||
},
|
|
||||||
onActivity: (activity) => {
|
|
||||||
switch (activity.type) {
|
|
||||||
case 'thinking':
|
|
||||||
showSpinner('Agent is thinking...')
|
|
||||||
break
|
|
||||||
case 'executing':
|
|
||||||
showSpinner(`Executing: ${activity.tool}`)
|
|
||||||
break
|
|
||||||
case 'executed':
|
|
||||||
log(`${activity.tool} completed in ${activity.duration}ms`)
|
|
||||||
break
|
|
||||||
case 'error':
|
|
||||||
showError(activity.message)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
},
|
|
||||||
onHistoryUpdate: (history) => {
|
|
||||||
renderHistory(history)
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
### Stop Execution
|
### Stop the Current Task
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Start a task
|
window.PAGE_AGENT_EXT!.stop()
|
||||||
window.PAGE_AGENT_EXT!.execute('Scroll through all pages', llmConfig)
|
|
||||||
|
|
||||||
// Later, stop it
|
|
||||||
window.PAGE_AGENT_EXT!.dispose()
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Window Type Declaration
|
## Window Type Declaration
|
||||||
|
|
||||||
If not using `@page-agent/core`, add this to your project:
|
If you are not importing `@page-agent/core`, add:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import type {
|
import type {
|
||||||
@@ -258,25 +210,29 @@ import type {
|
|||||||
AgentStatus,
|
AgentStatus,
|
||||||
ExecutionResult,
|
ExecutionResult,
|
||||||
HistoricalEvent,
|
HistoricalEvent,
|
||||||
LLMConfig,
|
|
||||||
} from '@page-agent/core'
|
} from '@page-agent/core'
|
||||||
|
|
||||||
|
interface ExecuteConfig {
|
||||||
|
baseURL: string
|
||||||
|
model: string
|
||||||
|
apiKey?: string
|
||||||
|
|
||||||
|
systemInstruction?: string
|
||||||
|
|
||||||
|
includeInitialTab?: boolean
|
||||||
|
experimentalIncludeAllTabs?: boolean
|
||||||
|
onStatusChange?: (status: AgentStatus) => void
|
||||||
|
onActivity?: (activity: AgentActivity) => void
|
||||||
|
onHistoryUpdate?: (history: HistoricalEvent[]) => void
|
||||||
|
}
|
||||||
|
|
||||||
declare global {
|
declare global {
|
||||||
interface Window {
|
interface Window {
|
||||||
PAGE_AGENT_EXT_VERSION?: string
|
PAGE_AGENT_EXT_VERSION?: string
|
||||||
PAGE_AGENT_EXT?: {
|
PAGE_AGENT_EXT?: {
|
||||||
version: string
|
version: string
|
||||||
execute: (
|
execute: Execute
|
||||||
task: string,
|
stop: () => void
|
||||||
llmConfig: LLMConfig,
|
|
||||||
hooks?: {
|
|
||||||
onStatusChange?: (status: AgentStatus) => void
|
|
||||||
onActivity?: (activity: AgentActivity) => void
|
|
||||||
onHistoryUpdate?: (history: HistoricalEvent[]) => void
|
|
||||||
onDispose?: () => void
|
|
||||||
}
|
|
||||||
) => Promise<ExecutionResult>
|
|
||||||
dispose: () => void
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,283 +0,0 @@
|
|||||||
# Page Agent 浏览器插件 API
|
|
||||||
|
|
||||||
本文档介绍如何在网页应用中接入 Page Agent 浏览器插件。
|
|
||||||
|
|
||||||
## 安装
|
|
||||||
|
|
||||||
### 1. 安装浏览器插件
|
|
||||||
|
|
||||||
从 Chrome 应用商店安装 Page Agent 插件。
|
|
||||||
|
|
||||||
### 2. 安装类型定义(推荐)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install @page-agent/core --save-dev
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. 配置认证
|
|
||||||
|
|
||||||
插件在页面加载后检测 `localStorage` 中的 token,匹配时才会注入 API。
|
|
||||||
|
|
||||||
1. 打开插件的侧边栏面板,获取授权 token
|
|
||||||
2. 在页面中设置 token:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
localStorage.setItem('PageAgentExtUserAuthToken', 'your-token')
|
|
||||||
```
|
|
||||||
|
|
||||||
## 快速开始
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import type {
|
|
||||||
AgentActivity,
|
|
||||||
AgentStatus,
|
|
||||||
ExecutionResult,
|
|
||||||
HistoricalEvent,
|
|
||||||
LLMConfig,
|
|
||||||
} from '@page-agent/core'
|
|
||||||
|
|
||||||
// 等待插件注入(最多 1 秒)
|
|
||||||
async function waitForExtension(timeout = 1000): Promise<boolean> {
|
|
||||||
const start = Date.now()
|
|
||||||
while (Date.now() - start < timeout) {
|
|
||||||
if (window.PAGE_AGENT_EXT) return true
|
|
||||||
await new Promise((r) => setTimeout(r, 100))
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// 使用
|
|
||||||
if (await waitForExtension()) {
|
|
||||||
const result = await window.PAGE_AGENT_EXT!.execute(
|
|
||||||
'点击登录按钮',
|
|
||||||
{
|
|
||||||
baseURL: 'https://api.openai.com/v1',
|
|
||||||
apiKey: 'your-api-key',
|
|
||||||
model: 'gpt-5.2',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
onStatusChange: (status) => console.log('状态:', status),
|
|
||||||
onActivity: (activity) => console.log('活动:', activity),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
console.log('结果:', result)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 全局 API
|
|
||||||
|
|
||||||
插件在 `window` 对象上注入以下 API:
|
|
||||||
|
|
||||||
### `window.PAGE_AGENT_EXT_VERSION`
|
|
||||||
|
|
||||||
插件版本号字符串(例如 `"1.0.0"`)。单独暴露版本号,方便在访问主 API 对象前进行版本检查。
|
|
||||||
|
|
||||||
### `window.PAGE_AGENT_EXT`
|
|
||||||
|
|
||||||
主 API 命名空间对象,包含:
|
|
||||||
|
|
||||||
#### `PAGE_AGENT_EXT.execute(task, llmConfig, hooks?)`
|
|
||||||
|
|
||||||
执行 Agent 任务。
|
|
||||||
|
|
||||||
**参数:**
|
|
||||||
|
|
||||||
| 名称 | 类型 | 必填 | 说明 |
|
|
||||||
|------|------|------|------|
|
|
||||||
| `task` | `string` | 是 | 任务描述 |
|
|
||||||
| `llmConfig` | `LLMConfig` | 是 | LLM 配置 |
|
|
||||||
| `hooks` | `ExecuteHooks` | 否 | 事件回调 |
|
|
||||||
|
|
||||||
**返回:** `Promise<ExecutionResult>`
|
|
||||||
|
|
||||||
#### `PAGE_AGENT_EXT.dispose()`
|
|
||||||
|
|
||||||
停止并销毁当前运行的 Agent。
|
|
||||||
|
|
||||||
## 类型定义
|
|
||||||
|
|
||||||
安装 `@page-agent/core` 获取完整类型:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import type {
|
|
||||||
AgentActivity,
|
|
||||||
AgentStatus,
|
|
||||||
ExecutionResult,
|
|
||||||
HistoricalEvent,
|
|
||||||
LLMConfig,
|
|
||||||
} from '@page-agent/core'
|
|
||||||
|
|
||||||
export interface ExecuteHooks {
|
|
||||||
onStatusChange?: (status: AgentStatus) => void
|
|
||||||
onActivity?: (activity: AgentActivity) => void
|
|
||||||
onHistoryUpdate?: (history: HistoricalEvent[]) => void
|
|
||||||
onDispose?: () => void
|
|
||||||
}
|
|
||||||
|
|
||||||
export type Execute = (
|
|
||||||
task: string,
|
|
||||||
llmConfig: LLMConfig,
|
|
||||||
hooks?: ExecuteHooks
|
|
||||||
) => Promise<ExecutionResult>
|
|
||||||
```
|
|
||||||
|
|
||||||
### AgentStatus
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
type AgentStatus = 'idle' | 'running' | 'completed' | 'error'
|
|
||||||
```
|
|
||||||
|
|
||||||
| 状态 | 说明 |
|
|
||||||
|------|------|
|
|
||||||
| `idle` | 空闲,准备执行 |
|
|
||||||
| `running` | 正在执行任务 |
|
|
||||||
| `completed` | 任务成功完成 |
|
|
||||||
| `error` | 任务执行失败 |
|
|
||||||
|
|
||||||
### AgentActivity
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
type AgentActivity =
|
|
||||||
| { type: 'thinking' }
|
|
||||||
| { type: 'executing'; tool: string; input: unknown }
|
|
||||||
| { type: 'executed'; tool: string; input: unknown; output: string; duration: number }
|
|
||||||
| { type: 'retrying'; attempt: number; maxAttempts: number }
|
|
||||||
| { type: 'error'; message: string }
|
|
||||||
```
|
|
||||||
|
|
||||||
| 类型 | 说明 |
|
|
||||||
|------|------|
|
|
||||||
| `thinking` | Agent 正在分析页面并规划 |
|
|
||||||
| `executing` | 正在执行工具操作 |
|
|
||||||
| `executed` | 工具执行完成 |
|
|
||||||
| `retrying` | 失败后重试 |
|
|
||||||
| `error` | 发生错误 |
|
|
||||||
|
|
||||||
### HistoricalEvent
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
type HistoricalEvent =
|
|
||||||
| { type: 'step'; stepIndex: number; reflection: AgentReflection; action: Action }
|
|
||||||
| { type: 'observation'; content: string }
|
|
||||||
| { type: 'user_takeover' }
|
|
||||||
| { type: 'retry'; message: string; attempt: number; maxAttempts: number }
|
|
||||||
| { type: 'error'; message: string; rawResponse?: unknown }
|
|
||||||
```
|
|
||||||
|
|
||||||
### LLMConfig
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
interface LLMConfig {
|
|
||||||
baseURL: string // 例如 'https://api.openai.com/v1'
|
|
||||||
apiKey: string
|
|
||||||
model: string // 例如 'gpt-5.2'
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### ExecutionResult
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
interface ExecutionResult {
|
|
||||||
success: boolean
|
|
||||||
data: string
|
|
||||||
history: HistoricalEvent[]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 使用示例
|
|
||||||
|
|
||||||
### 基础执行
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
const result = await window.PAGE_AGENT_EXT!.execute(
|
|
||||||
'在邮箱输入框填入 test@example.com 然后点击提交',
|
|
||||||
{
|
|
||||||
baseURL: 'https://api.openai.com/v1',
|
|
||||||
apiKey: process.env.OPENAI_API_KEY!,
|
|
||||||
model: 'gpt-5.2',
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
if (result.success) {
|
|
||||||
console.log('任务完成:', result.data)
|
|
||||||
} else {
|
|
||||||
console.error('任务失败')
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 使用事件回调
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
await window.PAGE_AGENT_EXT!.execute(
|
|
||||||
'导航到设置页面',
|
|
||||||
llmConfig,
|
|
||||||
{
|
|
||||||
onStatusChange: (status) => {
|
|
||||||
updateUI({ agentStatus: status })
|
|
||||||
},
|
|
||||||
onActivity: (activity) => {
|
|
||||||
switch (activity.type) {
|
|
||||||
case 'thinking':
|
|
||||||
showSpinner('Agent 正在思考...')
|
|
||||||
break
|
|
||||||
case 'executing':
|
|
||||||
showSpinner(`正在执行: ${activity.tool}`)
|
|
||||||
break
|
|
||||||
case 'executed':
|
|
||||||
log(`${activity.tool} 完成,耗时 ${activity.duration}ms`)
|
|
||||||
break
|
|
||||||
case 'error':
|
|
||||||
showError(activity.message)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
},
|
|
||||||
onHistoryUpdate: (history) => {
|
|
||||||
renderHistory(history)
|
|
||||||
},
|
|
||||||
}
|
|
||||||
)
|
|
||||||
```
|
|
||||||
|
|
||||||
### 停止执行
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// 启动任务
|
|
||||||
window.PAGE_AGENT_EXT!.execute('滚动浏览所有页面', llmConfig)
|
|
||||||
|
|
||||||
// 稍后停止
|
|
||||||
window.PAGE_AGENT_EXT!.dispose()
|
|
||||||
```
|
|
||||||
|
|
||||||
## Window 类型声明
|
|
||||||
|
|
||||||
如果不使用 `@page-agent/core`,可以添加以下声明:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import type {
|
|
||||||
AgentActivity,
|
|
||||||
AgentStatus,
|
|
||||||
ExecutionResult,
|
|
||||||
HistoricalEvent,
|
|
||||||
LLMConfig,
|
|
||||||
} from '@page-agent/core'
|
|
||||||
|
|
||||||
declare global {
|
|
||||||
interface Window {
|
|
||||||
PAGE_AGENT_EXT_VERSION?: string
|
|
||||||
PAGE_AGENT_EXT?: {
|
|
||||||
version: string
|
|
||||||
execute: (
|
|
||||||
task: string,
|
|
||||||
llmConfig: LLMConfig,
|
|
||||||
hooks?: {
|
|
||||||
onStatusChange?: (status: AgentStatus) => void
|
|
||||||
onActivity?: (activity: AgentActivity) => void
|
|
||||||
onHistoryUpdate?: (history: HistoricalEvent[]) => void
|
|
||||||
onDispose?: () => void
|
|
||||||
}
|
|
||||||
) => Promise<ExecutionResult>
|
|
||||||
dispose: () => void
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@page-agent/ext",
|
"name": "@page-agent/ext",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "0.1.2",
|
"version": "1.8.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "wxt",
|
"dev": "wxt",
|
||||||
@@ -10,38 +10,42 @@
|
|||||||
"postinstall": "wxt prepare"
|
"postinstall": "wxt prepare"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@tailwindcss/vite": "^4.1.18",
|
|
||||||
"@types/chrome": "^0.1.34",
|
|
||||||
"@types/react": "^19.2.8",
|
|
||||||
"@types/react-dom": "^19.2.1",
|
|
||||||
"@vitejs/plugin-react-swc": "^4.1.0",
|
|
||||||
"@wxt-dev/module-react": "^1.1.5",
|
|
||||||
"react": "^19.2.4",
|
|
||||||
"react-dom": "^19.2.4",
|
|
||||||
"tailwindcss": "^4.1.14",
|
|
||||||
"tw-animate-css": "^1.4.0",
|
|
||||||
"wxt": "^0.20.13"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"@page-agent/core": "1.1.0",
|
|
||||||
"@page-agent/llms": "1.1.0",
|
|
||||||
"@page-agent/page-controller": "1.1.0",
|
|
||||||
"@page-agent/ui": "1.1.0",
|
|
||||||
"@radix-ui/react-hover-card": "^1.1.15",
|
"@radix-ui/react-hover-card": "^1.1.15",
|
||||||
"@radix-ui/react-icons": "^1.3.2",
|
"@radix-ui/react-icons": "^1.3.2",
|
||||||
"@radix-ui/react-label": "^2.1.8",
|
"@radix-ui/react-label": "^2.1.8",
|
||||||
"@radix-ui/react-separator": "^1.1.8",
|
"@radix-ui/react-separator": "^1.1.8",
|
||||||
"@radix-ui/react-slot": "^1.2.4",
|
"@radix-ui/react-slot": "^1.2.4",
|
||||||
"@radix-ui/react-switch": "^1.2.6",
|
"@radix-ui/react-switch": "^1.2.6",
|
||||||
"@radix-ui/react-tooltip": "^1.2.8",
|
"@tailwindcss/vite": "^4.2.2",
|
||||||
|
"@types/chrome": "^0.1.40",
|
||||||
|
"@types/react": "^19.2.14",
|
||||||
|
"@types/react-dom": "^19.2.3",
|
||||||
|
"@wxt-dev/module-react": "^1.2.2",
|
||||||
"class-variance-authority": "^0.7.1",
|
"class-variance-authority": "^0.7.1",
|
||||||
"clsx": "^2.1.1",
|
"clsx": "^2.1.1",
|
||||||
"lucide-react": "^0.563.0",
|
"idb": "^8.0.3",
|
||||||
"motion": "^12.30.0",
|
"lucide-react": "^1.8.0",
|
||||||
|
"motion": "^12.38.0",
|
||||||
"next-themes": "^0.4.6",
|
"next-themes": "^0.4.6",
|
||||||
|
"react": "^19.2.5",
|
||||||
|
"react-dom": "^19.2.5",
|
||||||
"rough-notation": "^0.5.1",
|
"rough-notation": "^0.5.1",
|
||||||
"simple-icons": "^16.7.0",
|
"simple-icons": "^16.16.0",
|
||||||
"sonner": "^2.0.7",
|
"sonner": "^2.0.7",
|
||||||
"tailwind-merge": "^3.4.0"
|
"tailwind-merge": "^3.5.0",
|
||||||
|
"tailwindcss": "^4.2.2",
|
||||||
|
"tw-animate-css": "^1.4.0",
|
||||||
|
"wxt": "^0.20.20"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@page-agent/core": "1.8.0",
|
||||||
|
"@page-agent/llms": "1.8.0",
|
||||||
|
"@page-agent/page-controller": "1.8.0",
|
||||||
|
"@page-agent/ui": "1.8.0",
|
||||||
|
"ai-motion": "^0.4.8",
|
||||||
|
"chalk": "^5.6.2"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"zod": "^3.25.0 || ^4.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"extName": {
|
||||||
|
"message": "Page Agent Ext"
|
||||||
|
},
|
||||||
|
"extDescription": {
|
||||||
|
"message": "AI-powered browser automation assistant. Control web pages with natural language."
|
||||||
|
},
|
||||||
|
"extActionTitle": {
|
||||||
|
"message": "Open Page Agent"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"extName": {
|
||||||
|
"message": "Page Agent Ext"
|
||||||
|
},
|
||||||
|
"extDescription": {
|
||||||
|
"message": "AI 驱动的浏览器自动化助手,用自然语言控制网页。"
|
||||||
|
},
|
||||||
|
"extActionTitle": {
|
||||||
|
"message": "打开 Page Agent"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { type PageAgentConfig, PageAgentCore } from '@page-agent/core'
|
import { type AgentConfig, PageAgentCore } from '@page-agent/core'
|
||||||
|
|
||||||
import { RemotePageController } from './RemotePageController'
|
import { RemotePageController } from './RemotePageController'
|
||||||
import { TabsController } from './TabsController'
|
import { TabsController } from './TabsController'
|
||||||
@@ -11,13 +11,18 @@ function detectLanguage(): 'en-US' | 'zh-CN' {
|
|||||||
return lang.startsWith('zh') ? 'zh-CN' : 'en-US'
|
return lang.startsWith('zh') ? 'zh-CN' : 'en-US'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
interface MultiPageAgentConfig extends AgentConfig {
|
||||||
|
includeInitialTab?: boolean
|
||||||
|
experimentalIncludeAllTabs?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* MultiPageAgent
|
* MultiPageAgent
|
||||||
* - use with extension
|
* - use with extension
|
||||||
* - can be used from a side panel or a content script
|
* - can be used from a side panel or a content script
|
||||||
*/
|
*/
|
||||||
export class MultiPageAgent extends PageAgentCore {
|
export class MultiPageAgent extends PageAgentCore {
|
||||||
constructor(config: Omit<PageAgentConfig, 'pageController'>) {
|
constructor(config: MultiPageAgentConfig) {
|
||||||
// multi page controller
|
// multi page controller
|
||||||
const tabsController = new TabsController()
|
const tabsController = new TabsController()
|
||||||
const pageController = new RemotePageController(tabsController)
|
const pageController = new RemotePageController(tabsController)
|
||||||
@@ -31,6 +36,9 @@ export class MultiPageAgent extends PageAgentCore {
|
|||||||
`Default working language: **${targetLanguage}**`
|
`Default working language: **${targetLanguage}**`
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const includeInitialTab = config.includeInitialTab ?? true
|
||||||
|
const experimentalIncludeAllTabs = config.experimentalIncludeAllTabs ?? false
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* When the agent is in side-panel and user closed the side-panel.
|
* When the agent is in side-panel and user closed the side-panel.
|
||||||
* There is no chance for isAgentRunning to be set false.
|
* There is no chance for isAgentRunning to be set false.
|
||||||
@@ -47,7 +55,7 @@ export class MultiPageAgent extends PageAgentCore {
|
|||||||
customSystemPrompt: systemPrompt,
|
customSystemPrompt: systemPrompt,
|
||||||
|
|
||||||
onBeforeTask: async (agent) => {
|
onBeforeTask: async (agent) => {
|
||||||
await tabsController.init(agent.task)
|
await tabsController.init(agent.task, { includeInitialTab, experimentalIncludeAllTabs })
|
||||||
|
|
||||||
heartBeatInterval = window.setInterval(() => {
|
heartBeatInterval = window.setInterval(() => {
|
||||||
chrome.storage.local.set({
|
chrome.storage.local.set({
|
||||||
@@ -71,6 +79,12 @@ export class MultiPageAgent extends PageAgentCore {
|
|||||||
})
|
})
|
||||||
},
|
},
|
||||||
|
|
||||||
|
onBeforeStep: async (agent) => {
|
||||||
|
if (!tabsController.currentTabId) return
|
||||||
|
// make sure the current tab is loaded before the step starts
|
||||||
|
await tabsController.waitUntilTabLoaded(tabsController.currentTabId!)
|
||||||
|
},
|
||||||
|
|
||||||
onDispose: () => {
|
onDispose: () => {
|
||||||
if (heartBeatInterval) {
|
if (heartBeatInterval) {
|
||||||
window.clearInterval(heartBeatInterval)
|
window.clearInterval(heartBeatInterval)
|
||||||
@@ -81,8 +95,7 @@ export class MultiPageAgent extends PageAgentCore {
|
|||||||
isAgentRunning: false,
|
isAgentRunning: false,
|
||||||
})
|
})
|
||||||
|
|
||||||
// no need to dispose tabsController and pageController
|
tabsController.dispose()
|
||||||
// as they do not keep references
|
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,13 +8,19 @@ export function handlePageControlMessage(
|
|||||||
sender: chrome.runtime.MessageSender,
|
sender: chrome.runtime.MessageSender,
|
||||||
sendResponse: (response: unknown) => void
|
sendResponse: (response: unknown) => void
|
||||||
): true | undefined {
|
): true | undefined {
|
||||||
|
const PREFIX = '[RemotePageController.background]'
|
||||||
|
|
||||||
|
const debug = console.debug.bind(console, `\x1b[90m${PREFIX}\x1b[0m`)
|
||||||
|
|
||||||
const { action, payload, targetTabId } = message
|
const { action, payload, targetTabId } = message
|
||||||
|
|
||||||
if (action === 'get_my_tab_id') {
|
if (action === 'get_my_tab_id') {
|
||||||
|
debug('get_my_tab_id', sender.tab?.id)
|
||||||
sendResponse({ tabId: sender.tab?.id || null })
|
sendResponse({ tabId: sender.tab?.id || null })
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// proxy to content script
|
||||||
chrome.tabs
|
chrome.tabs
|
||||||
.sendMessage(targetTabId, {
|
.sendMessage(targetTabId, {
|
||||||
type: 'PAGE_CONTROL',
|
type: 'PAGE_CONTROL',
|
||||||
@@ -25,6 +31,7 @@ export function handlePageControlMessage(
|
|||||||
sendResponse(result)
|
sendResponse(result)
|
||||||
})
|
})
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
|
console.error(PREFIX, error)
|
||||||
sendResponse({
|
sendResponse({
|
||||||
success: false,
|
success: false,
|
||||||
error: error instanceof Error ? error.message : String(error),
|
error: error instanceof Error ? error.message : String(error),
|
||||||
|
|||||||
@@ -12,10 +12,17 @@ export function initPageController() {
|
|||||||
.then((response) => {
|
.then((response) => {
|
||||||
return (response as { tabId: number | null }).tabId
|
return (response as { tabId: number | null }).tabId
|
||||||
})
|
})
|
||||||
|
.catch((error) => {
|
||||||
|
console.error('[RemotePageController.ContentScript]: Failed to get my tab id', error)
|
||||||
|
return null
|
||||||
|
})
|
||||||
|
|
||||||
function getPC(): PageController {
|
function getPC(): PageController {
|
||||||
if (!pageController) {
|
if (!pageController) {
|
||||||
pageController = new PageController({ enableMask: false })
|
pageController = new PageController({
|
||||||
|
enableMask: false,
|
||||||
|
viewportExpansion: 400,
|
||||||
|
})
|
||||||
}
|
}
|
||||||
return pageController
|
return pageController
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,13 +2,29 @@ import type { BrowserState } from '@page-agent/page-controller'
|
|||||||
|
|
||||||
import type { TabsController } from './TabsController'
|
import type { TabsController } from './TabsController'
|
||||||
|
|
||||||
|
const PREFIX = '[RemotePageController]'
|
||||||
|
|
||||||
|
const debug = console.debug.bind(console, `\x1b[90m${PREFIX}\x1b[0m`)
|
||||||
|
|
||||||
|
function sendMessage(message: {
|
||||||
|
type: 'PAGE_CONTROL'
|
||||||
|
action: string
|
||||||
|
targetTabId: number
|
||||||
|
payload?: any
|
||||||
|
}): Promise<any> {
|
||||||
|
return chrome.runtime.sendMessage(message).catch((error) => {
|
||||||
|
console.error(PREFIX, message.action, error)
|
||||||
|
return null
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Agent side page controller.
|
* Agent side page controller.
|
||||||
* - live in the agent env (extension page or content script)
|
* - live in the agent env (extension page or content script)
|
||||||
* - communicates with remote PageController via sw
|
* - communicates with remote PageController via sw
|
||||||
*/
|
*/
|
||||||
export class RemotePageController {
|
export class RemotePageController {
|
||||||
private tabsController: TabsController
|
tabsController: TabsController
|
||||||
|
|
||||||
constructor(tabsController: TabsController) {
|
constructor(tabsController: TabsController) {
|
||||||
this.tabsController = tabsController
|
this.tabsController = tabsController
|
||||||
@@ -18,46 +34,44 @@ export class RemotePageController {
|
|||||||
return this.tabsController.currentTabId
|
return this.tabsController.currentTabId
|
||||||
}
|
}
|
||||||
|
|
||||||
async getCurrentUrl(): Promise<string> {
|
private async getCurrentUrl(): Promise<string> {
|
||||||
if (!this.currentTabId) return ''
|
if (!this.currentTabId) return ''
|
||||||
const { url } = await this.tabsController.getTabInfo(this.currentTabId)
|
const { url } = await this.tabsController.getTabInfo(this.currentTabId)
|
||||||
return url || ''
|
return url || ''
|
||||||
}
|
}
|
||||||
|
|
||||||
async getCurrentTitle(): Promise<string> {
|
private async getCurrentTitle(): Promise<string> {
|
||||||
if (!this.currentTabId) return ''
|
if (!this.currentTabId) return ''
|
||||||
const { title } = await this.tabsController.getTabInfo(this.currentTabId)
|
const { title } = await this.tabsController.getTabInfo(this.currentTabId)
|
||||||
return title || ''
|
return title || ''
|
||||||
}
|
}
|
||||||
|
|
||||||
get currentTabTitle(): Promise<string> {
|
|
||||||
return this.getCurrentTitle()
|
|
||||||
}
|
|
||||||
|
|
||||||
async getLastUpdateTime(): Promise<number> {
|
async getLastUpdateTime(): Promise<number> {
|
||||||
if (!this.currentTabId) throw new Error('tabsController not initialized.')
|
if (!this.currentTabId) throw new Error('tabsController not initialized.')
|
||||||
|
return sendMessage({
|
||||||
return await chrome.runtime.sendMessage({
|
|
||||||
type: 'PAGE_CONTROL',
|
type: 'PAGE_CONTROL',
|
||||||
action: 'get_last_update_time',
|
action: 'get_last_update_time',
|
||||||
targetTabId: this.currentTabId,
|
targetTabId: this.currentTabId,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// getBrowserState
|
|
||||||
async getBrowserState(): Promise<BrowserState> {
|
async getBrowserState(): Promise<BrowserState> {
|
||||||
let browserState = {} as BrowserState
|
let browserState: BrowserState
|
||||||
|
debug('getBrowserState', this.currentTabId)
|
||||||
|
|
||||||
if (!this.currentTabId || !isContentScriptAllowed(await this.currentTabUrl)) {
|
const currentUrl = await this.getCurrentUrl()
|
||||||
|
const currentTitle = await this.getCurrentTitle()
|
||||||
|
|
||||||
|
if (!this.currentTabId || !isContentScriptAllowed(currentUrl)) {
|
||||||
browserState = {
|
browserState = {
|
||||||
url: await this.currentTabUrl,
|
url: currentUrl,
|
||||||
title: await this.currentTabTitle,
|
title: currentTitle,
|
||||||
header: '',
|
header: '',
|
||||||
content: '(empty page)',
|
content: '(empty page. either current page is not readable or not loaded yet.)',
|
||||||
footer: '',
|
footer: '',
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
browserState = await chrome.runtime.sendMessage({
|
browserState = await sendMessage({
|
||||||
type: 'PAGE_CONTROL',
|
type: 'PAGE_CONTROL',
|
||||||
action: 'get_browser_state',
|
action: 'get_browser_state',
|
||||||
targetTabId: this.currentTabId,
|
targetTabId: this.currentTabId,
|
||||||
@@ -67,61 +81,58 @@ export class RemotePageController {
|
|||||||
const sum = await this.tabsController.summarizeTabs()
|
const sum = await this.tabsController.summarizeTabs()
|
||||||
browserState.header = sum + '\n\n' + (browserState.header || '')
|
browserState.header = sum + '\n\n' + (browserState.header || '')
|
||||||
|
|
||||||
|
debug('getBrowserState: success', this.currentTabId, browserState)
|
||||||
|
|
||||||
return browserState
|
return browserState
|
||||||
}
|
}
|
||||||
|
|
||||||
// updateTree
|
|
||||||
async updateTree(): Promise<void> {
|
async updateTree(): Promise<void> {
|
||||||
if (!this.currentTabId || !isContentScriptAllowed(await this.currentTabUrl)) {
|
if (!this.currentTabId || !isContentScriptAllowed(await this.getCurrentUrl())) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
await chrome.runtime.sendMessage({
|
await sendMessage({
|
||||||
type: 'PAGE_CONTROL',
|
type: 'PAGE_CONTROL',
|
||||||
action: 'update_tree',
|
action: 'update_tree',
|
||||||
targetTabId: this.currentTabId,
|
targetTabId: this.currentTabId,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// cleanUpHighlights
|
|
||||||
async cleanUpHighlights(): Promise<void> {
|
async cleanUpHighlights(): Promise<void> {
|
||||||
if (!this.currentTabId || !isContentScriptAllowed(await this.currentTabUrl)) {
|
if (!this.currentTabId || !isContentScriptAllowed(await this.getCurrentUrl())) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
await chrome.runtime.sendMessage({
|
await sendMessage({
|
||||||
type: 'PAGE_CONTROL',
|
type: 'PAGE_CONTROL',
|
||||||
action: 'clean_up_highlights',
|
action: 'clean_up_highlights',
|
||||||
targetTabId: this.currentTabId,
|
targetTabId: this.currentTabId,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// clickElement
|
|
||||||
async clickElement(...args: any[]): Promise<DomActionReturn> {
|
async clickElement(...args: any[]): Promise<DomActionReturn> {
|
||||||
return this.remoteCallDomAction('click_element', args)
|
const res = await this.remoteCallDomAction('click_element', args)
|
||||||
|
// @note may cause page navigation, wait for 1 second to ensure the page loading started
|
||||||
|
await new Promise((resolve) => setTimeout(resolve, 1000))
|
||||||
|
return res
|
||||||
}
|
}
|
||||||
|
|
||||||
// inputText
|
|
||||||
async inputText(...args: any[]): Promise<DomActionReturn> {
|
async inputText(...args: any[]): Promise<DomActionReturn> {
|
||||||
return this.remoteCallDomAction('input_text', args)
|
return this.remoteCallDomAction('input_text', args)
|
||||||
}
|
}
|
||||||
|
|
||||||
// selectOption
|
|
||||||
async selectOption(...args: any[]): Promise<DomActionReturn> {
|
async selectOption(...args: any[]): Promise<DomActionReturn> {
|
||||||
return this.remoteCallDomAction('select_option', args)
|
return this.remoteCallDomAction('select_option', args)
|
||||||
}
|
}
|
||||||
|
|
||||||
// scroll
|
|
||||||
async scroll(...args: any[]): Promise<DomActionReturn> {
|
async scroll(...args: any[]): Promise<DomActionReturn> {
|
||||||
return this.remoteCallDomAction('scroll', args)
|
return this.remoteCallDomAction('scroll', args)
|
||||||
}
|
}
|
||||||
|
|
||||||
// scrollHorizontally
|
|
||||||
async scrollHorizontally(...args: any[]): Promise<DomActionReturn> {
|
async scrollHorizontally(...args: any[]): Promise<DomActionReturn> {
|
||||||
return this.remoteCallDomAction('scroll_horizontally', args)
|
return this.remoteCallDomAction('scroll_horizontally', args)
|
||||||
}
|
}
|
||||||
|
|
||||||
// executeJavascript
|
|
||||||
async executeJavascript(...args: any[]): Promise<DomActionReturn> {
|
async executeJavascript(...args: any[]): Promise<DomActionReturn> {
|
||||||
return this.remoteCallDomAction('execute_javascript', args)
|
return this.remoteCallDomAction('execute_javascript', args)
|
||||||
}
|
}
|
||||||
@@ -133,35 +144,26 @@ export class RemotePageController {
|
|||||||
/** @note Managed by content script via storage polling. */
|
/** @note Managed by content script via storage polling. */
|
||||||
dispose(): void {}
|
dispose(): void {}
|
||||||
|
|
||||||
private async preCheck() {
|
|
||||||
if (!this.currentTabId) {
|
|
||||||
return 'RemotePageController not initialized.'
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!isContentScriptAllowed(await this.currentTabUrl)) {
|
|
||||||
return 'Operation not allowed on this page. Use open_new_tab to navigate to a web page first.'
|
|
||||||
}
|
|
||||||
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
|
|
||||||
private async remoteCallDomAction(action: string, payload: any[]): Promise<DomActionReturn> {
|
private async remoteCallDomAction(action: string, payload: any[]): Promise<DomActionReturn> {
|
||||||
const preCheckError = await this.preCheck()
|
if (!this.currentTabId) {
|
||||||
if (preCheckError) {
|
return { success: false, message: 'RemotePageController not initialized.' }
|
||||||
return { success: false, message: preCheckError }
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return await chrome.runtime.sendMessage({
|
if (!isContentScriptAllowed(await this.getCurrentUrl())) {
|
||||||
|
return {
|
||||||
|
success: false,
|
||||||
|
message:
|
||||||
|
'Operation not allowed on this page. Use open_new_tab to navigate to a web page first.',
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return sendMessage({
|
||||||
type: 'PAGE_CONTROL',
|
type: 'PAGE_CONTROL',
|
||||||
action: action,
|
action: action,
|
||||||
targetTabId: this.currentTabId!,
|
targetTabId: this.currentTabId!,
|
||||||
payload,
|
payload,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
private get currentTabUrl(): Promise<string> {
|
|
||||||
return this.getCurrentUrl()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
interface DomActionReturn {
|
interface DomActionReturn {
|
||||||
@@ -172,7 +174,7 @@ interface DomActionReturn {
|
|||||||
/**
|
/**
|
||||||
* Check if a URL can run content scripts.
|
* Check if a URL can run content scripts.
|
||||||
*/
|
*/
|
||||||
function isContentScriptAllowed(url: string | undefined): boolean {
|
export function isContentScriptAllowed(url: string | undefined): boolean {
|
||||||
if (!url) return false
|
if (!url) return false
|
||||||
|
|
||||||
const restrictedPatterns = [
|
const restrictedPatterns = [
|
||||||
|
|||||||
@@ -3,6 +3,10 @@
|
|||||||
*/
|
*/
|
||||||
import type { TabAction } from './TabsController'
|
import type { TabAction } from './TabsController'
|
||||||
|
|
||||||
|
const PREFIX = '[TabsController.background]'
|
||||||
|
|
||||||
|
const debug = console.debug.bind(console, `\x1b[90m${PREFIX}\x1b[0m`)
|
||||||
|
|
||||||
export function handleTabControlMessage(
|
export function handleTabControlMessage(
|
||||||
message: { type: 'TAB_CONTROL'; action: TabAction; payload: any },
|
message: { type: 'TAB_CONTROL'; action: TabAction; payload: any },
|
||||||
sender: chrome.runtime.MessageSender,
|
sender: chrome.runtime.MessageSender,
|
||||||
@@ -12,11 +16,12 @@ export function handleTabControlMessage(
|
|||||||
|
|
||||||
switch (action as TabAction) {
|
switch (action as TabAction) {
|
||||||
case 'get_active_tab': {
|
case 'get_active_tab': {
|
||||||
|
debug('get_active_tab')
|
||||||
chrome.tabs
|
chrome.tabs
|
||||||
.query({ active: true, currentWindow: true })
|
.query({ active: true })
|
||||||
.then((tabs) => {
|
.then((tabs) => {
|
||||||
const tabId = tabs.length > 0 ? tabs[0].id || null : null
|
debug('get_active_tab: success', tabs)
|
||||||
sendResponse({ success: true, tabId })
|
sendResponse({ success: true, tab: tabs[0] })
|
||||||
})
|
})
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
sendResponse({ error: error instanceof Error ? error.message : String(error) })
|
sendResponse({ error: error instanceof Error ? error.message : String(error) })
|
||||||
@@ -25,11 +30,12 @@ export function handleTabControlMessage(
|
|||||||
}
|
}
|
||||||
|
|
||||||
case 'get_tab_info': {
|
case 'get_tab_info': {
|
||||||
|
debug('get_tab_info', payload)
|
||||||
chrome.tabs
|
chrome.tabs
|
||||||
.get(payload.tabId)
|
.get(payload.tabId)
|
||||||
.then((tab) => {
|
.then((tab) => {
|
||||||
const result = { title: tab.title || '', url: tab.url || '' }
|
debug('get_tab_info: success', tab)
|
||||||
sendResponse(result)
|
sendResponse(tab)
|
||||||
})
|
})
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
sendResponse({ error: error instanceof Error ? error.message : String(error) })
|
sendResponse({ error: error instanceof Error ? error.message : String(error) })
|
||||||
@@ -38,11 +44,12 @@ export function handleTabControlMessage(
|
|||||||
}
|
}
|
||||||
|
|
||||||
case 'open_new_tab': {
|
case 'open_new_tab': {
|
||||||
|
debug('open_new_tab', payload)
|
||||||
chrome.tabs
|
chrome.tabs
|
||||||
.create({ url: payload.url, active: false })
|
.create({ url: payload.url, active: false })
|
||||||
.then((newTab) => {
|
.then((newTab) => {
|
||||||
// @todo: wait for tab to be fully loaded
|
debug('open_new_tab: success', newTab)
|
||||||
sendResponse({ success: true, tabId: newTab.id, windowId: newTab.windowId })
|
sendResponse({ success: true, tabId: newTab.id })
|
||||||
})
|
})
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
sendResponse({ error: error instanceof Error ? error.message : String(error) })
|
sendResponse({ error: error instanceof Error ? error.message : String(error) })
|
||||||
@@ -51,20 +58,22 @@ export function handleTabControlMessage(
|
|||||||
}
|
}
|
||||||
|
|
||||||
case 'create_tab_group': {
|
case 'create_tab_group': {
|
||||||
|
debug('create_tab_group', payload)
|
||||||
chrome.tabs
|
chrome.tabs
|
||||||
.group({ tabIds: payload.tabIds, createProperties: { windowId: payload.windowId } })
|
.group({ tabIds: payload.tabIds, createProperties: { windowId: payload.windowId } })
|
||||||
.then((groupId) => {
|
.then((groupId) => {
|
||||||
console.log('Created tab group', groupId)
|
debug('create_tab_group: success', groupId)
|
||||||
sendResponse({ success: true, groupId })
|
sendResponse({ success: true, groupId })
|
||||||
})
|
})
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
console.error('Failed to create tab group', error)
|
console.error(PREFIX, 'Failed to create tab group', error)
|
||||||
sendResponse({ error: error instanceof Error ? error.message : String(error) })
|
sendResponse({ error: error instanceof Error ? error.message : String(error) })
|
||||||
})
|
})
|
||||||
return true // async response
|
return true // async response
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'update_tab_group': {
|
case 'update_tab_group': {
|
||||||
|
debug('update_tab_group', payload)
|
||||||
chrome.tabGroups
|
chrome.tabGroups
|
||||||
.update(payload.groupId, payload.properties)
|
.update(payload.groupId, payload.properties)
|
||||||
.then(() => {
|
.then(() => {
|
||||||
@@ -77,6 +86,7 @@ export function handleTabControlMessage(
|
|||||||
}
|
}
|
||||||
|
|
||||||
case 'add_tab_to_group': {
|
case 'add_tab_to_group': {
|
||||||
|
debug('add_tab_to_group', payload)
|
||||||
chrome.tabs
|
chrome.tabs
|
||||||
.group({ tabIds: payload.tabId, groupId: payload.groupId })
|
.group({ tabIds: payload.tabId, groupId: payload.groupId })
|
||||||
.then(() => {
|
.then(() => {
|
||||||
@@ -89,6 +99,7 @@ export function handleTabControlMessage(
|
|||||||
}
|
}
|
||||||
|
|
||||||
case 'close_tab': {
|
case 'close_tab': {
|
||||||
|
debug('close_tab', payload)
|
||||||
chrome.tabs
|
chrome.tabs
|
||||||
.remove(payload.tabId)
|
.remove(payload.tabId)
|
||||||
.then(() => {
|
.then(() => {
|
||||||
@@ -100,8 +111,59 @@ export function handleTabControlMessage(
|
|||||||
return true // async response
|
return true // async response
|
||||||
}
|
}
|
||||||
|
|
||||||
|
case 'get_window_tabs': {
|
||||||
|
debug('get_window_tabs', payload)
|
||||||
|
chrome.tabs
|
||||||
|
.query({ windowId: payload.windowId })
|
||||||
|
.then((tabs) => {
|
||||||
|
sendResponse({ success: true, tabs })
|
||||||
|
})
|
||||||
|
.catch((error) => {
|
||||||
|
sendResponse({ error: error instanceof Error ? error.message : String(error) })
|
||||||
|
})
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
default:
|
default:
|
||||||
sendResponse({ error: `Unknown action: ${action}` })
|
sendResponse({ error: `Unknown action: ${action}` })
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const tabEventPorts = new Set<chrome.runtime.Port>()
|
||||||
|
|
||||||
|
function broadcastTabEvent(message: object) {
|
||||||
|
for (const port of tabEventPorts) {
|
||||||
|
port.postMessage(message)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Port-based tab events: agents connect via `chrome.runtime.connect({ name: 'tab-events' })`
|
||||||
|
* and receive tab change events through the port. Works for both extension pages and content scripts.
|
||||||
|
*/
|
||||||
|
export function setupTabEventsPort() {
|
||||||
|
chrome.runtime.onConnect.addListener((port) => {
|
||||||
|
if (port.name !== 'tab-events') return
|
||||||
|
|
||||||
|
debug('port connected', port.sender?.tab?.id ?? port.sender?.url)
|
||||||
|
tabEventPorts.add(port)
|
||||||
|
|
||||||
|
port.onDisconnect.addListener(() => {
|
||||||
|
debug('port disconnected')
|
||||||
|
tabEventPorts.delete(port)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
chrome.tabs.onCreated.addListener((tab) => {
|
||||||
|
broadcastTabEvent({ action: 'created', payload: { tab } })
|
||||||
|
})
|
||||||
|
|
||||||
|
chrome.tabs.onRemoved.addListener((tabId, removeInfo) => {
|
||||||
|
broadcastTabEvent({ action: 'removed', payload: { tabId, removeInfo } })
|
||||||
|
})
|
||||||
|
|
||||||
|
chrome.tabs.onUpdated.addListener((tabId, changeInfo, tab) => {
|
||||||
|
broadcastTabEvent({ action: 'updated', payload: { tabId, changeInfo, tab } })
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,85 +1,127 @@
|
|||||||
|
import { isContentScriptAllowed } from './RemotePageController'
|
||||||
|
|
||||||
|
const PREFIX = '[TabsController]'
|
||||||
|
|
||||||
|
const debug = console.debug.bind(console, `\x1b[90m${PREFIX}\x1b[0m`)
|
||||||
|
|
||||||
|
function sendMessage(message: {
|
||||||
|
type: 'TAB_CONTROL'
|
||||||
|
action: TabAction
|
||||||
|
payload?: any
|
||||||
|
}): Promise<any> {
|
||||||
|
return chrome.runtime.sendMessage(message).catch((error) => {
|
||||||
|
console.error(PREFIX, message.action, error)
|
||||||
|
return null
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Controller for managing browser tabs.
|
* Controller for managing browser tabs.
|
||||||
* - live in the agent env (extension page or content script)
|
* - live in the agent env (extension page or content script)
|
||||||
* - no chrome apis. call sw for tab operations
|
* - no chrome apis. call sw for tab operations
|
||||||
*/
|
*/
|
||||||
export class TabsController extends EventTarget {
|
export class TabsController {
|
||||||
currentTabId: number | null = null
|
currentTabId: number | null = null
|
||||||
|
|
||||||
|
private disposed = false
|
||||||
|
private port?: chrome.runtime.Port
|
||||||
|
private portRetries = 0
|
||||||
|
|
||||||
|
private windowId: number | null = null
|
||||||
private tabs: TabMeta[] = []
|
private tabs: TabMeta[] = []
|
||||||
private initialTabId: number | null = null
|
private initialTabId: number | null = null
|
||||||
private tabGroupId: number | null = null
|
private tabGroupId: number | null = null
|
||||||
|
private experimentalIncludeAllTabs = false
|
||||||
private task: string = ''
|
private task: string = ''
|
||||||
private windowId: number | null = null
|
|
||||||
|
|
||||||
async init(task: string) {
|
async init(task: string, options: TabsInitOptions = {}) {
|
||||||
this.task = task
|
const { includeInitialTab = true, experimentalIncludeAllTabs = false } = options
|
||||||
this.tabs = []
|
debug('init', task, options)
|
||||||
|
|
||||||
|
if (this.disposed) {
|
||||||
|
throw new Error('TabsController already disposed')
|
||||||
|
}
|
||||||
|
|
||||||
this.currentTabId = null
|
this.currentTabId = null
|
||||||
|
this.disposed = false
|
||||||
|
this.port = undefined
|
||||||
|
this.portRetries = 0
|
||||||
|
|
||||||
|
this.windowId = null
|
||||||
|
this.tabs = []
|
||||||
this.tabGroupId = null
|
this.tabGroupId = null
|
||||||
this.initialTabId = null
|
this.initialTabId = null
|
||||||
this.windowId = null
|
this.experimentalIncludeAllTabs = experimentalIncludeAllTabs
|
||||||
|
this.task = task
|
||||||
|
|
||||||
const result = await chrome.runtime.sendMessage({
|
const activeTabResult = await sendMessage({
|
||||||
type: 'TAB_CONTROL',
|
type: 'TAB_CONTROL',
|
||||||
action: 'get_active_tab',
|
action: 'get_active_tab',
|
||||||
})
|
})
|
||||||
|
|
||||||
this.initialTabId = result.tabId
|
this.initialTabId = activeTabResult.tab?.id
|
||||||
this.currentTabId = result.tabId
|
this.windowId = activeTabResult.tab?.windowId
|
||||||
|
|
||||||
this.tabs.push({
|
if (!this.initialTabId || !this.windowId) {
|
||||||
id: result.tabId,
|
if (activeTabResult.error) {
|
||||||
isInitial: true,
|
throw new Error(activeTabResult.error)
|
||||||
})
|
} else {
|
||||||
|
throw new Error('Failed to get active tab')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if (!this.initialTabId) {
|
this.connectTabEvents()
|
||||||
throw new Error('Failed to get initial tab ID')
|
|
||||||
|
if (experimentalIncludeAllTabs) {
|
||||||
|
const allTabs = await sendMessage({
|
||||||
|
type: 'TAB_CONTROL',
|
||||||
|
action: 'get_window_tabs',
|
||||||
|
payload: { windowId: this.windowId },
|
||||||
|
})
|
||||||
|
for (const tab of allTabs.tabs as chrome.tabs.Tab[]) {
|
||||||
|
if (tab.id && !tab.pinned && isContentScriptAllowed(tab.url)) {
|
||||||
|
this.addTab({
|
||||||
|
id: tab.id,
|
||||||
|
isInitial: tab.id === this.initialTabId,
|
||||||
|
url: tab.url,
|
||||||
|
title: tab.title,
|
||||||
|
status: tab.status,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (this.tabs.find((t) => t.id === this.initialTabId)) {
|
||||||
|
this.currentTabId = this.initialTabId
|
||||||
|
await this.createTabGroup([this.initialTabId])
|
||||||
|
}
|
||||||
|
} else if (includeInitialTab) {
|
||||||
|
const info = await sendMessage({
|
||||||
|
type: 'TAB_CONTROL',
|
||||||
|
action: 'get_tab_info',
|
||||||
|
payload: { tabId: this.initialTabId },
|
||||||
|
})
|
||||||
|
|
||||||
|
if (isContentScriptAllowed(info.url) && !info.pinned) {
|
||||||
|
this.currentTabId = this.initialTabId
|
||||||
|
|
||||||
|
this.addTab({
|
||||||
|
id: this.initialTabId,
|
||||||
|
isInitial: true,
|
||||||
|
url: info.url,
|
||||||
|
title: info.title,
|
||||||
|
status: info.status,
|
||||||
|
})
|
||||||
|
|
||||||
|
await this.createTabGroup([this.initialTabId])
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
await this.updateCurrentTabId(this.currentTabId)
|
await this.updateCurrentTabId(this.currentTabId)
|
||||||
|
|
||||||
const tabChangeHandler = (message: any): void => {
|
|
||||||
if (message.type !== 'TAB_CHANGE') {
|
|
||||||
// throw new Error(`[TabsController]: Invalid message type: ${message.type}`)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (message.action === 'created') {
|
|
||||||
const tab = message.payload.tab as chrome.tabs.Tab
|
|
||||||
if (tab.groupId === this.tabGroupId && tab.id != null) {
|
|
||||||
// Tab created in our controlled group
|
|
||||||
if (!this.tabs.find((t) => t.id === tab.id)) {
|
|
||||||
this.tabs.push({ id: tab.id, isInitial: false })
|
|
||||||
}
|
|
||||||
this.switchToTab(tab.id)
|
|
||||||
}
|
|
||||||
} else if (message.action === 'removed') {
|
|
||||||
const { tabId } = message.payload as { tabId: number }
|
|
||||||
const targetTab = this.tabs.find((t) => t.id === tabId)
|
|
||||||
if (targetTab) {
|
|
||||||
this.tabs = this.tabs.filter((t) => t.id !== tabId)
|
|
||||||
if (this.currentTabId === tabId) {
|
|
||||||
const newCurrentTab = this.tabs[this.tabs.length - 1] || null
|
|
||||||
if (newCurrentTab) {
|
|
||||||
this.switchToTab(newCurrentTab.id)
|
|
||||||
} else {
|
|
||||||
this.updateCurrentTabId(null)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
chrome.runtime.onMessage.addListener(tabChangeHandler)
|
|
||||||
|
|
||||||
this.addEventListener('dispose', () => {
|
|
||||||
chrome.runtime.onMessage.removeListener(tabChangeHandler)
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async openNewTab(url: string): Promise<{ success: boolean; tabId: number; message: string }> {
|
async openNewTab(url: string): Promise<string> {
|
||||||
const result = await chrome.runtime.sendMessage({
|
debug('openNewTab', url)
|
||||||
|
|
||||||
|
const result = await sendMessage({
|
||||||
type: 'TAB_CONTROL',
|
type: 'TAB_CONTROL',
|
||||||
action: 'open_new_tab',
|
action: 'open_new_tab',
|
||||||
payload: { url },
|
payload: { url },
|
||||||
@@ -90,11 +132,8 @@ export class TabsController extends EventTarget {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const tabId = result.tabId as number
|
const tabId = result.tabId as number
|
||||||
const windowId = result.windowId as number
|
|
||||||
|
|
||||||
this.windowId = windowId
|
this.addTab({
|
||||||
|
|
||||||
this.tabs.push({
|
|
||||||
id: tabId,
|
id: tabId,
|
||||||
isInitial: false,
|
isInitial: false,
|
||||||
})
|
})
|
||||||
@@ -102,84 +141,45 @@ export class TabsController extends EventTarget {
|
|||||||
await this.switchToTab(tabId)
|
await this.switchToTab(tabId)
|
||||||
|
|
||||||
if (!this.tabGroupId) {
|
if (!this.tabGroupId) {
|
||||||
const result = await chrome.runtime.sendMessage({
|
await this.createTabGroup([tabId])
|
||||||
type: 'TAB_CONTROL',
|
|
||||||
action: 'create_tab_group',
|
|
||||||
payload: { tabIds: [tabId], windowId: this.windowId },
|
|
||||||
})
|
|
||||||
|
|
||||||
if (!result.success) {
|
|
||||||
throw new Error(`Failed to create tab group: ${result.error}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
const groupId = result.groupId as number
|
|
||||||
|
|
||||||
this.tabGroupId = groupId
|
|
||||||
|
|
||||||
await chrome.runtime.sendMessage({
|
|
||||||
type: 'TAB_CONTROL',
|
|
||||||
action: 'update_tab_group',
|
|
||||||
payload: {
|
|
||||||
groupId: this.tabGroupId,
|
|
||||||
properties: {
|
|
||||||
title: `PageAgent(${this.task})`,
|
|
||||||
color: randomColor(),
|
|
||||||
collapsed: false,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
} else {
|
} else {
|
||||||
await chrome.runtime.sendMessage({
|
await sendMessage({
|
||||||
type: 'TAB_CONTROL',
|
type: 'TAB_CONTROL',
|
||||||
action: 'add_tab_to_group',
|
action: 'add_tab_to_group',
|
||||||
payload: { tabId: result.tabId, groupId: this.tabGroupId },
|
payload: { tabId: result.tabId, groupId: this.tabGroupId },
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// wait for the new tab to be fully loaded
|
await this.waitUntilTabLoaded(tabId)
|
||||||
// @todo
|
|
||||||
await new Promise((resolve) => setTimeout(resolve, 500))
|
|
||||||
|
|
||||||
return {
|
return `✅ Opened new tab ID ${tabId} with URL ${url}`
|
||||||
success: true,
|
|
||||||
tabId,
|
|
||||||
message: `Opened new tab ID ${tabId} with URL ${url}`,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async switchToTab(tabId: number): Promise<{ success: boolean; message: string }> {
|
async switchToTab(tabId: number): Promise<string> {
|
||||||
|
debug('switchToTab', tabId)
|
||||||
|
|
||||||
const targetTab = this.tabs.find((t) => t.id === tabId)
|
const targetTab = this.tabs.find((t) => t.id === tabId)
|
||||||
if (!targetTab) {
|
if (!targetTab) {
|
||||||
return {
|
throw new Error(`Tab ID ${tabId} not found in tab list.`)
|
||||||
success: false,
|
|
||||||
message: `Tab ID ${tabId} not found in tab list.`,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
await this.updateCurrentTabId(tabId)
|
await this.updateCurrentTabId(tabId)
|
||||||
|
|
||||||
return {
|
return `✅ Switched to tab ID ${tabId}.`
|
||||||
success: true,
|
|
||||||
message: `Switched to tab ID ${tabId}.`,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async closeTab(tabId: number): Promise<{ success: boolean; message: string }> {
|
async closeTab(tabId: number): Promise<string> {
|
||||||
|
debug('closeTab', tabId)
|
||||||
|
|
||||||
const targetTab = this.tabs.find((t) => t.id === tabId)
|
const targetTab = this.tabs.find((t) => t.id === tabId)
|
||||||
if (!targetTab) {
|
if (!targetTab) {
|
||||||
return {
|
throw new Error(`Tab ID ${tabId} not found in tab list.`)
|
||||||
success: false,
|
|
||||||
message: `Tab ID ${tabId} not found in tab list.`,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if (targetTab.isInitial) {
|
if (targetTab.isInitial) {
|
||||||
return {
|
throw new Error(`Cannot close the initial tab ID ${tabId}.`)
|
||||||
success: false,
|
|
||||||
message: `Cannot close the initial tab ID ${tabId}.`,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = await chrome.runtime.sendMessage({
|
const result = await sendMessage({
|
||||||
type: 'TAB_CONTROL',
|
type: 'TAB_CONTROL',
|
||||||
action: 'close_tab',
|
action: 'close_tab',
|
||||||
payload: { tabId },
|
payload: { tabId },
|
||||||
@@ -196,29 +196,71 @@ export class TabsController extends EventTarget {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return `✅ Closed tab ID ${tabId}.`
|
||||||
success: true,
|
|
||||||
message: `Closed tab ID ${tabId}.`,
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
return {
|
throw new Error(`Failed to close tab ID ${tabId}: ${result.error}`)
|
||||||
success: false,
|
|
||||||
message: `Failed to close tab ID ${tabId}: ${result.error}`,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private async createTabGroup(tabIds: number[]) {
|
||||||
|
const result = await sendMessage({
|
||||||
|
type: 'TAB_CONTROL',
|
||||||
|
action: 'create_tab_group',
|
||||||
|
payload: { tabIds, windowId: this.windowId },
|
||||||
|
})
|
||||||
|
|
||||||
|
if (!result?.success) {
|
||||||
|
throw new Error(`Failed to create tab group: ${result?.error}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.tabGroupId = result.groupId as number
|
||||||
|
|
||||||
|
await sendMessage({
|
||||||
|
type: 'TAB_CONTROL',
|
||||||
|
action: 'update_tab_group',
|
||||||
|
payload: {
|
||||||
|
groupId: this.tabGroupId,
|
||||||
|
properties: {
|
||||||
|
title: `PageAgent(${this.task})`,
|
||||||
|
color: randomColor(),
|
||||||
|
collapsed: false,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
private addTab(meta: TabMeta) {
|
||||||
|
if (this.tabs.find((t) => t.id === meta.id)) return
|
||||||
|
this.tabs.push(meta)
|
||||||
|
}
|
||||||
|
|
||||||
async updateCurrentTabId(tabId: number | null) {
|
async updateCurrentTabId(tabId: number | null) {
|
||||||
|
debug('updateCurrentTabId', tabId)
|
||||||
|
|
||||||
this.currentTabId = tabId
|
this.currentTabId = tabId
|
||||||
await chrome.storage.local.set({ currentTabId: tabId })
|
await chrome.storage.local.set({ currentTabId: tabId })
|
||||||
}
|
}
|
||||||
|
|
||||||
async getTabInfo(tabId: number): Promise<{ title: string; url: string }> {
|
async getTabInfo(tabId: number): Promise<{ title: string; url: string }> {
|
||||||
const result = await chrome.runtime.sendMessage({
|
// use cached tab info if available
|
||||||
|
const tabMeta = this.tabs.find((t) => t.id === tabId)
|
||||||
|
if (tabMeta && tabMeta.url && tabMeta.title) {
|
||||||
|
return { title: tabMeta.title, url: tabMeta.url }
|
||||||
|
}
|
||||||
|
|
||||||
|
// otherwise, pull the latest tab info from the background script
|
||||||
|
debug('getTabInfo: pulling from background script', tabId)
|
||||||
|
const result = await sendMessage({
|
||||||
type: 'TAB_CONTROL',
|
type: 'TAB_CONTROL',
|
||||||
action: 'get_tab_info',
|
action: 'get_tab_info',
|
||||||
payload: { tabId },
|
payload: { tabId },
|
||||||
})
|
})
|
||||||
|
|
||||||
|
if (tabMeta) {
|
||||||
|
tabMeta.url = result.url
|
||||||
|
tabMeta.title = result.title
|
||||||
|
}
|
||||||
|
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -230,12 +272,95 @@ export class TabsController extends EventTarget {
|
|||||||
`| ${tab.id} | ${url} | ${title} | ${this.currentTabId === tab.id ? '✅' : ''} |`
|
`| ${tab.id} | ${url} | ${title} | ${this.currentTabId === tab.id ? '✅' : ''} |`
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
if (!this.tabs.length) {
|
||||||
|
summaries.push('\nNo tabs available. Open a tab if needed.')
|
||||||
|
}
|
||||||
|
|
||||||
return summaries.join('\n')
|
return summaries.join('\n')
|
||||||
}
|
}
|
||||||
|
|
||||||
dispose() {
|
async waitUntilTabLoaded(tabId: number): Promise<void> {
|
||||||
this.dispatchEvent(new Event('dispose'))
|
const tab = this.tabs.find((t) => t.id === tabId)
|
||||||
|
if (!tab) throw new Error(`Tab ID ${tabId} not found in tab list.`)
|
||||||
|
|
||||||
|
if (tab.status === 'unloaded') throw new Error(`Tab ID ${tabId} is unloaded.`)
|
||||||
|
if (tab.status === 'complete') return
|
||||||
|
|
||||||
|
debug('waitUntilTabLoaded', tabId)
|
||||||
|
await waitUntil(() => tab.status === 'complete', 4_000)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Connect to background SW via port to receive tab change events.
|
||||||
|
*
|
||||||
|
* @note Port is 1:1 (runtime.connect → background SW has no frames),
|
||||||
|
* so onDisconnect fires exactly once and we can safely reconnect.
|
||||||
|
* Reconnection may miss events during the gap.
|
||||||
|
* TODO: refresh this.tabs from background after reconnect to stay consistent.
|
||||||
|
*/
|
||||||
|
private connectTabEvents() {
|
||||||
|
this.port = chrome.runtime.connect({ name: 'tab-events' })
|
||||||
|
|
||||||
|
this.port.onMessage.addListener((message: any) => {
|
||||||
|
if (this.disposed) return
|
||||||
|
this.portRetries = 0
|
||||||
|
|
||||||
|
if (message.action === 'created') {
|
||||||
|
const tab = message.payload.tab as chrome.tabs.Tab
|
||||||
|
const shouldTrack = this.experimentalIncludeAllTabs || tab.groupId === this.tabGroupId
|
||||||
|
if (shouldTrack && tab.id != null) {
|
||||||
|
this.addTab({ id: tab.id, isInitial: false })
|
||||||
|
this.switchToTab(tab.id)
|
||||||
|
}
|
||||||
|
} else if (message.action === 'removed') {
|
||||||
|
const { tabId } = message.payload as { tabId: number }
|
||||||
|
const targetTab = this.tabs.find((t) => t.id === tabId)
|
||||||
|
if (targetTab) {
|
||||||
|
this.tabs = this.tabs.filter((t) => t.id !== tabId)
|
||||||
|
if (this.currentTabId === tabId) {
|
||||||
|
const newCurrentTab = this.tabs[this.tabs.length - 1] || null
|
||||||
|
if (newCurrentTab) {
|
||||||
|
this.switchToTab(newCurrentTab.id)
|
||||||
|
} else {
|
||||||
|
this.updateCurrentTabId(null)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else if (message.action === 'updated') {
|
||||||
|
const { tabId, tab } = message.payload as { tabId: number; tab: chrome.tabs.Tab }
|
||||||
|
const targetTab = this.tabs.find((t) => t.id === tabId)
|
||||||
|
if (targetTab) {
|
||||||
|
targetTab.url = tab.url
|
||||||
|
targetTab.title = tab.title
|
||||||
|
targetTab.status = tab.status
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
this.port.onDisconnect.addListener(() => {
|
||||||
|
this.port = undefined
|
||||||
|
if (this.disposed) return
|
||||||
|
if (this.portRetries >= 7) {
|
||||||
|
console.error(PREFIX, 'tab events port failed after 7 retries, giving up')
|
||||||
|
return
|
||||||
|
}
|
||||||
|
debug('port disconnected, reconnecting...')
|
||||||
|
this.portRetries++
|
||||||
|
this.connectTabEvents()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
dispose() {
|
||||||
|
debug('dispose')
|
||||||
|
this.disposed = true
|
||||||
|
this.port?.disconnect()
|
||||||
|
this.port = undefined
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TabsInitOptions {
|
||||||
|
includeInitialTab?: boolean
|
||||||
|
experimentalIncludeAllTabs?: boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
export type TabAction =
|
export type TabAction =
|
||||||
@@ -247,25 +372,50 @@ export type TabAction =
|
|||||||
| 'add_tab_to_group'
|
| 'add_tab_to_group'
|
||||||
| 'close_tab'
|
| 'close_tab'
|
||||||
| 'get_tab_title'
|
| 'get_tab_title'
|
||||||
|
| 'get_window_tabs'
|
||||||
|
|
||||||
interface TabMeta {
|
interface TabMeta {
|
||||||
id: number
|
id: number
|
||||||
isInitial: boolean
|
isInitial: boolean
|
||||||
|
url?: string
|
||||||
|
title?: string
|
||||||
|
status?: 'loading' | 'unloaded' | 'complete'
|
||||||
}
|
}
|
||||||
|
|
||||||
const TAB_GROUP_COLORS = [
|
const TAB_GROUP_COLORS = ['blue', 'red', 'yellow', 'green', 'pink', 'purple', 'cyan'] as const
|
||||||
'grey',
|
|
||||||
'blue',
|
|
||||||
'red',
|
|
||||||
'yellow',
|
|
||||||
'green',
|
|
||||||
'pink',
|
|
||||||
'purple',
|
|
||||||
'cyan',
|
|
||||||
] as const
|
|
||||||
|
|
||||||
type TabGroupColor = (typeof TAB_GROUP_COLORS)[number]
|
type TabGroupColor = (typeof TAB_GROUP_COLORS)[number]
|
||||||
|
|
||||||
function randomColor(): TabGroupColor {
|
function randomColor(): TabGroupColor {
|
||||||
return TAB_GROUP_COLORS[Math.floor(Math.random() * TAB_GROUP_COLORS.length)]
|
return TAB_GROUP_COLORS[Math.floor(Math.random() * TAB_GROUP_COLORS.length)]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wait until condition becomes true
|
||||||
|
* @returns Returns when condition becomes true, throws otherwise
|
||||||
|
* @param timeoutMS Timeout in milliseconds, default 1 minutes, throws error on timeout
|
||||||
|
* @param error Error object to reject on timeout. If not provided, will resolve with false
|
||||||
|
*/
|
||||||
|
export async function waitUntil(
|
||||||
|
check: () => boolean | Promise<boolean>,
|
||||||
|
timeoutMS = 60_000,
|
||||||
|
error?: string
|
||||||
|
): Promise<boolean> {
|
||||||
|
if (await check()) return true
|
||||||
|
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const start = Date.now()
|
||||||
|
const poll = async () => {
|
||||||
|
if (await check()) return resolve(true)
|
||||||
|
if (Date.now() - start > timeoutMS) {
|
||||||
|
if (error) {
|
||||||
|
return reject(new Error(error))
|
||||||
|
} else {
|
||||||
|
return resolve(false)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
setTimeout(poll, 100)
|
||||||
|
}
|
||||||
|
setTimeout(poll, 100)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,13 +1,30 @@
|
|||||||
import type { LLMConfig } from '@page-agent/llms'
|
import type { LLMConfig } from '@page-agent/llms'
|
||||||
|
|
||||||
// Demo LLM for testing
|
// Demo LLM for testing
|
||||||
export const DEMO_MODEL = 'PAGE-AGENT-FREE-TESTING-RANDOM'
|
export const DEMO_MODEL = 'qwen3.5-plus'
|
||||||
export const DEMO_BASE_URL =
|
export const DEMO_BASE_URL = 'https://page-ag-testing-ohftxirgbn.cn-shanghai.fcapp.run'
|
||||||
'https://hwcxiuzfylggtcktqgij.supabase.co/functions/v1/llm-testing-proxy'
|
// export const DEMO_API_KEY = 'NA'
|
||||||
export const DEMO_API_KEY = 'PAGE-AGENT-FREE-TESTING-RANDOM'
|
|
||||||
|
|
||||||
export const DEMO_CONFIG: LLMConfig = {
|
export const DEMO_CONFIG: LLMConfig = {
|
||||||
apiKey: DEMO_API_KEY,
|
|
||||||
baseURL: DEMO_BASE_URL,
|
baseURL: DEMO_BASE_URL,
|
||||||
model: DEMO_MODEL,
|
model: DEMO_MODEL,
|
||||||
|
// apiKey: DEMO_API_KEY,
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Legacy testing endpoints that should be auto-migrated to DEMO_BASE_URL */
|
||||||
|
export const LEGACY_TESTING_ENDPOINTS = [
|
||||||
|
'https://hwcxiuzfylggtcktqgij.supabase.co/functions/v1/llm-testing-proxy',
|
||||||
|
]
|
||||||
|
|
||||||
|
export function isTestingEndpoint(url: string): boolean {
|
||||||
|
const normalized = url.replace(/\/+$/, '')
|
||||||
|
return normalized === DEMO_BASE_URL || LEGACY_TESTING_ENDPOINTS.some((ep) => normalized === ep)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function migrateLegacyEndpoint(config: LLMConfig): LLMConfig {
|
||||||
|
const normalized = config.baseURL.replace(/\/+$/, '')
|
||||||
|
if (LEGACY_TESTING_ENDPOINTS.some((ep) => normalized === ep)) {
|
||||||
|
return { ...DEMO_CONFIG }
|
||||||
|
}
|
||||||
|
return config
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -71,7 +71,7 @@ Strictly follow these rules while using the browser and navigating the web:
|
|||||||
- By default, only elements in the visible viewport are listed. Use scrolling actions if you suspect relevant content is offscreen which you need to interact with. Scroll ONLY if there are more pixels below or above the page.
|
- By default, only elements in the visible viewport are listed. Use scrolling actions if you suspect relevant content is offscreen which you need to interact with. Scroll ONLY if there are more pixels below or above the page.
|
||||||
- You can scroll by a specific number of pages using the num_pages parameter (e.g., 0.5 for half page, 2.0 for two pages).
|
- You can scroll by a specific number of pages using the num_pages parameter (e.g., 0.5 for half page, 2.0 for two pages).
|
||||||
- All the elements that are scrollable are marked with `data-scrollable` attribute. Including the scrollable distance in every directions. You can scroll *the element* in case some area are overflowed.
|
- All the elements that are scrollable are marked with `data-scrollable` attribute. Including the scrollable distance in every directions. You can scroll *the element* in case some area are overflowed.
|
||||||
- If a captcha appears, tell user you can not solve captcha. finished the task and ask user to solve it.
|
- If a captcha appears, tell user you can not solve captcha. Finish the task and ask user to solve it.
|
||||||
- If expected elements are missing, try scrolling, or navigating back.
|
- If expected elements are missing, try scrolling, or navigating back.
|
||||||
- If the page is not fully loaded, use the `wait` action.
|
- If the page is not fully loaded, use the `wait` action.
|
||||||
- Do not repeat one action for more than 3 times unless some conditions changed.
|
- Do not repeat one action for more than 3 times unless some conditions changed.
|
||||||
@@ -120,7 +120,6 @@ Exhibit the following reasoning patterns to successfully achieve the <user_reque
|
|||||||
Here are examples of good output patterns. Use them as reference but never copy them directly.
|
Here are examples of good output patterns. Use them as reference but never copy them directly.
|
||||||
|
|
||||||
<evaluation_examples>
|
<evaluation_examples>
|
||||||
- Positive Examples:
|
|
||||||
"evaluation_previous_goal": "Successfully navigated to the product page and found the target information. Verdict: Success"
|
"evaluation_previous_goal": "Successfully navigated to the product page and found the target information. Verdict: Success"
|
||||||
"evaluation_previous_goal": "Clicked the login button and user authentication form appeared. Verdict: Success"
|
"evaluation_previous_goal": "Clicked the login button and user authentication form appeared. Verdict: Success"
|
||||||
</evaluation_examples>
|
</evaluation_examples>
|
||||||
@@ -131,17 +130,16 @@ Here are examples of good output patterns. Use them as reference but never copy
|
|||||||
|
|
||||||
<next_goal_examples>
|
<next_goal_examples>
|
||||||
"next_goal": "Click on the 'Add to Cart' button to proceed with the purchase flow."
|
"next_goal": "Click on the 'Add to Cart' button to proceed with the purchase flow."
|
||||||
"next_goal": "Extract details from the first item on the page."
|
|
||||||
</next_goal_examples>
|
</next_goal_examples>
|
||||||
</examples>
|
</examples>
|
||||||
|
|
||||||
<output>
|
<output>
|
||||||
You must ALWAYS respond with a valid JSON in this exact format:
|
|
||||||
|
|
||||||
{
|
{
|
||||||
"evaluation_previous_goal": "Concise one-sentence analysis of your last action. Clearly state success, failure, or uncertain.",
|
"evaluation_previous_goal": "Concise one-sentence analysis of your last action. Clearly state success, failure, or uncertain.",
|
||||||
"memory": "1-3 concise sentences of specific memory of this step and overall progress. You should put here everything that will help you track progress in future steps. Like counting pages visited, items found, etc.",
|
"memory": "1-3 concise sentences of specific memory of this step and overall progress. You should put here everything that will help you track progress in future steps. Like counting pages visited, items found, etc.",
|
||||||
"next_goal": "State the next immediate goal and action to achieve it, in one clear sentence."
|
"next_goal": "State the next immediate goal and action to achieve it, in one clear sentence.",
|
||||||
"action":{"action_name": {// action-specific parameter}}
|
"action":{
|
||||||
|
"Action name": {// Action parameters}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
</output>
|
</output>
|
||||||
|
|||||||
@@ -6,14 +6,14 @@
|
|||||||
* - switch_to_tab: Switch to an existing tab
|
* - switch_to_tab: Switch to an existing tab
|
||||||
* - close_tab: Close a tab (optionally switch to another)
|
* - close_tab: Close a tab (optionally switch to another)
|
||||||
*/
|
*/
|
||||||
import zod from 'zod'
|
import * as z from 'zod/v4'
|
||||||
|
|
||||||
import type { TabsController } from './TabsController'
|
import type { TabsController } from './TabsController'
|
||||||
|
|
||||||
/** Tool definition compatible with PageAgentCore customTools */
|
/** Tool definition compatible with PageAgentCore customTools */
|
||||||
interface TabTool {
|
interface TabTool {
|
||||||
description: string
|
description: string
|
||||||
inputSchema: zod.ZodType
|
inputSchema: z.ZodType
|
||||||
execute: (input: unknown) => Promise<string>
|
execute: (input: unknown) => Promise<string>
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -26,37 +26,48 @@ export function createTabTools(tabsController: TabsController): Record<string, T
|
|||||||
open_new_tab: {
|
open_new_tab: {
|
||||||
description:
|
description:
|
||||||
'Open a new browser tab with the specified URL. The new tab becomes the current tab for all subsequent page operations.',
|
'Open a new browser tab with the specified URL. The new tab becomes the current tab for all subsequent page operations.',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
url: zod.string().describe('The URL to open in the new tab'),
|
url: z.string().describe('The URL to open in the new tab'),
|
||||||
}),
|
}),
|
||||||
execute: async (input: unknown) => {
|
execute: async (input: unknown) => {
|
||||||
const { url } = input as { url: string }
|
const { url } = input as { url: string }
|
||||||
const result = await tabsController.openNewTab(url)
|
try {
|
||||||
return result.message
|
return await tabsController.openNewTab(url)
|
||||||
|
} catch (error) {
|
||||||
|
return `❌ Failed: ${error instanceof Error ? error.message : String(error)}`
|
||||||
|
}
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
switch_to_tab: {
|
switch_to_tab: {
|
||||||
description:
|
description:
|
||||||
'Switch to an existing tab by its ID. After switching, all page operations will target the new current tab. You can only switch to tabs in the tab list shown in browser state.',
|
'Switch to an existing tab by its ID. After switching, all page operations will target the new current tab. You can only switch to tabs in the tab list shown in browser state.',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
tab_id: zod.number().int().describe('The tab ID to switch to'),
|
tab_id: z.number().int().describe('The tab ID to switch to'),
|
||||||
}),
|
}),
|
||||||
execute: async (input: unknown) => {
|
execute: async (input: unknown) => {
|
||||||
const { tab_id } = input as { tab_id: number }
|
const { tab_id } = input as { tab_id: number }
|
||||||
return (await tabsController.switchToTab(tab_id)).message
|
try {
|
||||||
|
return await tabsController.switchToTab(tab_id)
|
||||||
|
} catch (error) {
|
||||||
|
return `❌ Failed: ${error instanceof Error ? error.message : String(error)}`
|
||||||
|
}
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
close_tab: {
|
close_tab: {
|
||||||
description:
|
description:
|
||||||
'Close a tab by its ID. Cannot close the initial tab. Optionally specify which tab to switch to after closing.',
|
'Close a tab by its ID. Cannot close the initial tab. Optionally specify which tab to switch to after closing.',
|
||||||
inputSchema: zod.object({
|
inputSchema: z.object({
|
||||||
tab_id: zod.number().int().describe('The tab ID to close'),
|
tab_id: z.number().int().describe('The tab ID to close'),
|
||||||
}),
|
}),
|
||||||
execute: async (input: unknown) => {
|
execute: async (input: unknown) => {
|
||||||
const { tab_id } = input as { tab_id: number }
|
const { tab_id } = input as { tab_id: number }
|
||||||
return (await tabsController.closeTab(tab_id)).message
|
try {
|
||||||
|
return await tabsController.closeTab(tab_id)
|
||||||
|
} catch (error) {
|
||||||
|
return `❌ Failed: ${error instanceof Error ? error.message : String(error)}`
|
||||||
|
}
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,22 +1,43 @@
|
|||||||
/**
|
/**
|
||||||
* React hook for using AgentController
|
* React hook for using AgentController
|
||||||
*/
|
*/
|
||||||
import type { AgentActivity, AgentStatus, HistoricalEvent } from '@page-agent/core'
|
import type {
|
||||||
|
AgentActivity,
|
||||||
|
AgentStatus,
|
||||||
|
ExecutionResult,
|
||||||
|
HistoricalEvent,
|
||||||
|
SupportedLanguage,
|
||||||
|
} from '@page-agent/core'
|
||||||
import type { LLMConfig } from '@page-agent/llms'
|
import type { LLMConfig } from '@page-agent/llms'
|
||||||
import { useCallback, useEffect, useRef, useState } from 'react'
|
import { useCallback, useEffect, useRef, useState } from 'react'
|
||||||
|
|
||||||
import { MultiPageAgent } from './MultiPageAgent'
|
import { MultiPageAgent } from './MultiPageAgent'
|
||||||
import { DEMO_CONFIG } from './constants'
|
import { DEMO_CONFIG, migrateLegacyEndpoint } from './constants'
|
||||||
|
|
||||||
|
/** Language preference: undefined means follow system */
|
||||||
|
export type LanguagePreference = SupportedLanguage | undefined
|
||||||
|
|
||||||
|
export interface AdvancedConfig {
|
||||||
|
maxSteps?: number
|
||||||
|
systemInstruction?: string
|
||||||
|
experimentalLlmsTxt?: boolean
|
||||||
|
experimentalIncludeAllTabs?: boolean
|
||||||
|
disableNamedToolChoice?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ExtConfig extends LLMConfig, AdvancedConfig {
|
||||||
|
language?: LanguagePreference
|
||||||
|
}
|
||||||
|
|
||||||
export interface UseAgentResult {
|
export interface UseAgentResult {
|
||||||
status: AgentStatus
|
status: AgentStatus
|
||||||
history: HistoricalEvent[]
|
history: HistoricalEvent[]
|
||||||
activity: AgentActivity | null
|
activity: AgentActivity | null
|
||||||
currentTask: string
|
currentTask: string
|
||||||
config: LLMConfig | null
|
config: ExtConfig | null
|
||||||
execute: (task: string) => Promise<void>
|
execute: (task: string) => Promise<ExecutionResult>
|
||||||
stop: () => void
|
stop: () => void
|
||||||
configure: (config: LLMConfig) => Promise<void>
|
configure: (config: ExtConfig) => Promise<void>
|
||||||
}
|
}
|
||||||
|
|
||||||
export function useAgent(): UseAgentResult {
|
export function useAgent(): UseAgentResult {
|
||||||
@@ -25,23 +46,35 @@ export function useAgent(): UseAgentResult {
|
|||||||
const [history, setHistory] = useState<HistoricalEvent[]>([])
|
const [history, setHistory] = useState<HistoricalEvent[]>([])
|
||||||
const [activity, setActivity] = useState<AgentActivity | null>(null)
|
const [activity, setActivity] = useState<AgentActivity | null>(null)
|
||||||
const [currentTask, setCurrentTask] = useState('')
|
const [currentTask, setCurrentTask] = useState('')
|
||||||
const [config, setConfig] = useState<LLMConfig | null>(null)
|
const [config, setConfig] = useState<ExtConfig | null>(null)
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
chrome.storage.local.get('llmConfig').then((result) => {
|
chrome.storage.local.get(['llmConfig', 'language', 'advancedConfig']).then((result) => {
|
||||||
if (result.llmConfig) {
|
let llmConfig = (result.llmConfig as LLMConfig) ?? DEMO_CONFIG
|
||||||
setConfig(result.llmConfig as LLMConfig)
|
const language = (result.language as SupportedLanguage) || undefined
|
||||||
} else {
|
const advancedConfig = (result.advancedConfig as AdvancedConfig) ?? {}
|
||||||
|
|
||||||
|
// Auto-migrate legacy testing endpoints
|
||||||
|
const migrated = migrateLegacyEndpoint(llmConfig)
|
||||||
|
if (migrated !== llmConfig) {
|
||||||
|
llmConfig = migrated
|
||||||
|
chrome.storage.local.set({ llmConfig: migrated })
|
||||||
|
} else if (!result.llmConfig) {
|
||||||
chrome.storage.local.set({ llmConfig: DEMO_CONFIG })
|
chrome.storage.local.set({ llmConfig: DEMO_CONFIG })
|
||||||
setConfig(DEMO_CONFIG)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
setConfig({ ...llmConfig, ...advancedConfig, language })
|
||||||
})
|
})
|
||||||
}, [])
|
}, [])
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!config) return
|
if (!config) return
|
||||||
|
|
||||||
const agent = new MultiPageAgent(config)
|
const { systemInstruction, ...agentConfig } = config
|
||||||
|
const agent = new MultiPageAgent({
|
||||||
|
...agentConfig,
|
||||||
|
instructions: systemInstruction ? { system: systemInstruction } : undefined,
|
||||||
|
})
|
||||||
agentRef.current = agent
|
agentRef.current = agent
|
||||||
|
|
||||||
const handleStatusChange = (e: Event) => {
|
const handleStatusChange = (e: Event) => {
|
||||||
@@ -75,22 +108,46 @@ export function useAgent(): UseAgentResult {
|
|||||||
|
|
||||||
const execute = useCallback(async (task: string) => {
|
const execute = useCallback(async (task: string) => {
|
||||||
const agent = agentRef.current
|
const agent = agentRef.current
|
||||||
console.log('Fire task:', task, agent)
|
console.log('🚀 [useAgent] start executing task:', task)
|
||||||
if (!agent) throw new Error('Agent not initialized')
|
if (!agent) throw new Error('Agent not initialized')
|
||||||
|
|
||||||
setCurrentTask(task)
|
setCurrentTask(task)
|
||||||
setHistory([])
|
setHistory([])
|
||||||
await agent.execute(task)
|
return agent.execute(task)
|
||||||
}, [])
|
}, [])
|
||||||
|
|
||||||
const stop = useCallback(() => {
|
const stop = useCallback(() => {
|
||||||
agentRef.current?.dispose()
|
agentRef.current?.stop()
|
||||||
}, [])
|
}, [])
|
||||||
|
|
||||||
const configure = useCallback(async (newConfig: LLMConfig) => {
|
const configure = useCallback(
|
||||||
await chrome.storage.local.set({ llmConfig: newConfig })
|
async ({
|
||||||
setConfig(newConfig)
|
language,
|
||||||
}, [])
|
maxSteps,
|
||||||
|
systemInstruction,
|
||||||
|
experimentalLlmsTxt,
|
||||||
|
experimentalIncludeAllTabs,
|
||||||
|
disableNamedToolChoice,
|
||||||
|
...llmConfig
|
||||||
|
}: ExtConfig) => {
|
||||||
|
await chrome.storage.local.set({ llmConfig })
|
||||||
|
if (language) {
|
||||||
|
await chrome.storage.local.set({ language })
|
||||||
|
} else {
|
||||||
|
await chrome.storage.local.remove('language')
|
||||||
|
}
|
||||||
|
const advancedConfig: AdvancedConfig = {
|
||||||
|
maxSteps,
|
||||||
|
systemInstruction,
|
||||||
|
experimentalLlmsTxt,
|
||||||
|
experimentalIncludeAllTabs,
|
||||||
|
disableNamedToolChoice,
|
||||||
|
}
|
||||||
|
await chrome.storage.local.set({ advancedConfig })
|
||||||
|
setConfig({ ...llmConfig, ...advancedConfig, language })
|
||||||
|
},
|
||||||
|
[]
|
||||||
|
)
|
||||||
|
|
||||||
return {
|
return {
|
||||||
status,
|
status,
|
||||||
|
|||||||
@@ -111,6 +111,41 @@
|
|||||||
--color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
|
--color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
|
||||||
--color-sidebar-border: var(--sidebar-border);
|
--color-sidebar-border: var(--sidebar-border);
|
||||||
--color-sidebar-ring: var(--sidebar-ring);
|
--color-sidebar-ring: var(--sidebar-ring);
|
||||||
|
--animate-blink-cursor: blink-cursor 1.2s step-end infinite;
|
||||||
|
@keyframes blink-cursor {
|
||||||
|
0%,
|
||||||
|
49% {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
50%,
|
||||||
|
100% {
|
||||||
|
opacity: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes glow-a {
|
||||||
|
0%,
|
||||||
|
100% {
|
||||||
|
opacity: 0.45;
|
||||||
|
transform: scale(1);
|
||||||
|
}
|
||||||
|
50% {
|
||||||
|
opacity: 0;
|
||||||
|
transform: scale(1.1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes glow-b {
|
||||||
|
0%,
|
||||||
|
100% {
|
||||||
|
opacity: 0;
|
||||||
|
transform: scale(1.1);
|
||||||
|
}
|
||||||
|
50% {
|
||||||
|
opacity: 0.45;
|
||||||
|
transform: scale(1);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@layer base {
|
@layer base {
|
||||||
|
|||||||
+161
-26
@@ -1,34 +1,67 @@
|
|||||||
import type { LLMConfig } from '@page-agent/llms'
|
import {
|
||||||
import { Copy, CornerUpLeft, Eye, EyeOff, HatGlasses, Home, Loader2, Scale } from 'lucide-react'
|
Copy,
|
||||||
|
CornerUpLeft,
|
||||||
|
ExternalLink,
|
||||||
|
Eye,
|
||||||
|
EyeOff,
|
||||||
|
FoldVertical,
|
||||||
|
HatGlasses,
|
||||||
|
Home,
|
||||||
|
Loader2,
|
||||||
|
Scale,
|
||||||
|
UnfoldVertical,
|
||||||
|
} from 'lucide-react'
|
||||||
import { useEffect, useState } from 'react'
|
import { useEffect, useState } from 'react'
|
||||||
import { siGithub } from 'simple-icons'
|
import { siGithub } from 'simple-icons'
|
||||||
|
|
||||||
import { DEMO_API_KEY, DEMO_BASE_URL, DEMO_MODEL } from '@/agent/constants'
|
import { DEMO_BASE_URL, DEMO_MODEL, isTestingEndpoint } from '@/agent/constants'
|
||||||
|
import type { ExtConfig, LanguagePreference } from '@/agent/useAgent'
|
||||||
import { Button } from '@/components/ui/button'
|
import { Button } from '@/components/ui/button'
|
||||||
import { Input } from '@/components/ui/input'
|
import { Input } from '@/components/ui/input'
|
||||||
|
import { Switch } from '@/components/ui/switch'
|
||||||
|
|
||||||
interface ConfigPanelProps {
|
interface ConfigPanelProps {
|
||||||
config: LLMConfig | null
|
config: ExtConfig | null
|
||||||
onSave: (config: LLMConfig) => Promise<void>
|
onSave: (config: ExtConfig) => Promise<void>
|
||||||
onClose: () => void
|
onClose: () => void
|
||||||
}
|
}
|
||||||
|
|
||||||
export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
||||||
const [apiKey, setApiKey] = useState(config?.apiKey || DEMO_API_KEY)
|
|
||||||
const [baseURL, setBaseURL] = useState(config?.baseURL || DEMO_BASE_URL)
|
const [baseURL, setBaseURL] = useState(config?.baseURL || DEMO_BASE_URL)
|
||||||
const [model, setModel] = useState(config?.model || DEMO_MODEL)
|
const [model, setModel] = useState(config?.model || DEMO_MODEL)
|
||||||
|
const [apiKey, setApiKey] = useState(config?.apiKey)
|
||||||
|
const [language, setLanguage] = useState<LanguagePreference>(config?.language)
|
||||||
|
const [maxSteps, setMaxSteps] = useState(config?.maxSteps)
|
||||||
|
const [systemInstruction, setSystemInstruction] = useState(config?.systemInstruction ?? '')
|
||||||
|
const [experimentalLlmsTxt, setExperimentalLlmsTxt] = useState(
|
||||||
|
config?.experimentalLlmsTxt ?? false
|
||||||
|
)
|
||||||
|
const [experimentalIncludeAllTabs, setExperimentalIncludeAllTabs] = useState(
|
||||||
|
config?.experimentalIncludeAllTabs ?? false
|
||||||
|
)
|
||||||
|
const [disableNamedToolChoice, setDisableNamedToolChoice] = useState(
|
||||||
|
config?.disableNamedToolChoice ?? false
|
||||||
|
)
|
||||||
|
const [advancedOpen, setAdvancedOpen] = useState(false)
|
||||||
const [saving, setSaving] = useState(false)
|
const [saving, setSaving] = useState(false)
|
||||||
const [userAuthToken, setUserAuthToken] = useState<string>('')
|
const [userAuthToken, setUserAuthToken] = useState('')
|
||||||
const [copied, setCopied] = useState(false)
|
const [copied, setCopied] = useState(false)
|
||||||
const [showToken, setShowToken] = useState(false)
|
const [showToken, setShowToken] = useState(false)
|
||||||
const [showApiKey, setShowApiKey] = useState(false)
|
const [showApiKey, setShowApiKey] = useState(false)
|
||||||
|
|
||||||
// Update local state when config prop changes
|
const [prevConfig, setPrevConfig] = useState(config)
|
||||||
useEffect(() => {
|
if (prevConfig !== config) {
|
||||||
setApiKey(config?.apiKey || DEMO_API_KEY)
|
setPrevConfig(config)
|
||||||
setBaseURL(config?.baseURL || DEMO_BASE_URL)
|
setBaseURL(config?.baseURL || DEMO_BASE_URL)
|
||||||
setModel(config?.model || DEMO_MODEL)
|
setModel(config?.model || DEMO_MODEL)
|
||||||
}, [config])
|
setApiKey(config?.apiKey)
|
||||||
|
setLanguage(config?.language)
|
||||||
|
setMaxSteps(config?.maxSteps)
|
||||||
|
setSystemInstruction(config?.systemInstruction ?? '')
|
||||||
|
setExperimentalLlmsTxt(config?.experimentalLlmsTxt ?? false)
|
||||||
|
setExperimentalIncludeAllTabs(config?.experimentalIncludeAllTabs ?? false)
|
||||||
|
setDisableNamedToolChoice(config?.disableNamedToolChoice ?? false)
|
||||||
|
}
|
||||||
|
|
||||||
// Poll for user auth token every second until found
|
// Poll for user auth token every second until found
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
@@ -65,7 +98,17 @@ export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
|||||||
const handleSave = async () => {
|
const handleSave = async () => {
|
||||||
setSaving(true)
|
setSaving(true)
|
||||||
try {
|
try {
|
||||||
await onSave({ apiKey, baseURL, model })
|
await onSave({
|
||||||
|
apiKey,
|
||||||
|
baseURL,
|
||||||
|
model,
|
||||||
|
language,
|
||||||
|
maxSteps: maxSteps || undefined,
|
||||||
|
systemInstruction: systemInstruction || undefined,
|
||||||
|
experimentalLlmsTxt,
|
||||||
|
experimentalIncludeAllTabs,
|
||||||
|
disableNamedToolChoice,
|
||||||
|
})
|
||||||
} finally {
|
} finally {
|
||||||
setSaving(false)
|
setSaving(false)
|
||||||
}
|
}
|
||||||
@@ -89,7 +132,7 @@ export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
|||||||
<div className="flex flex-col gap-1.5 p-3 bg-muted/50 rounded-md border">
|
<div className="flex flex-col gap-1.5 p-3 bg-muted/50 rounded-md border">
|
||||||
<label className="text-xs font-medium text-muted-foreground">User Auth Token</label>
|
<label className="text-xs font-medium text-muted-foreground">User Auth Token</label>
|
||||||
<p className="text-[10px] text-muted-foreground mb-1">
|
<p className="text-[10px] text-muted-foreground mb-1">
|
||||||
Add this token to a website's localStorage to give it authorization to call this extension
|
Give a website the ability to call this extension.
|
||||||
</p>
|
</p>
|
||||||
<div className="flex gap-2 items-center">
|
<div className="flex gap-2 items-center">
|
||||||
<Input
|
<Input
|
||||||
@@ -124,6 +167,16 @@ export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
{/* Hub link */}
|
||||||
|
<a
|
||||||
|
href="/hub.html"
|
||||||
|
target="_blank"
|
||||||
|
className="flex items-center justify-between p-3 rounded-md border bg-muted/50 text-xs font-medium text-muted-foreground hover:text-foreground hover:border-foreground/20 transition-colors"
|
||||||
|
>
|
||||||
|
Manage Page Agent Hub
|
||||||
|
<ExternalLink className="size-3" />
|
||||||
|
</a>
|
||||||
|
|
||||||
<div className="flex flex-col gap-1.5">
|
<div className="flex flex-col gap-1.5">
|
||||||
<label className="text-xs text-muted-foreground">Base URL</label>
|
<label className="text-xs text-muted-foreground">Base URL</label>
|
||||||
<Input
|
<Input
|
||||||
@@ -134,10 +187,26 @@ export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
|||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
{/* Testing API notice */}
|
||||||
|
{isTestingEndpoint(baseURL) && (
|
||||||
|
<div className="p-2.5 rounded-md border border-amber-500/30 bg-amber-500/5 text-[11px] text-muted-foreground leading-relaxed">
|
||||||
|
<Scale className="size-3 inline-block mr-1 -mt-0.5 text-amber-600" />
|
||||||
|
You are using our testing API. By using this you agree to the{' '}
|
||||||
|
<a
|
||||||
|
href="https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
className="underline hover:text-foreground"
|
||||||
|
>
|
||||||
|
Terms of Use & Privacy Policy
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
<div className="flex flex-col gap-1.5">
|
<div className="flex flex-col gap-1.5">
|
||||||
<label className="text-xs text-muted-foreground">Model</label>
|
<label className="text-xs text-muted-foreground">Model</label>
|
||||||
<Input
|
<Input
|
||||||
placeholder="gpt-5.2"
|
placeholder="gpt-5.1"
|
||||||
value={model}
|
value={model}
|
||||||
onChange={(e) => setModel(e.target.value)}
|
onChange={(e) => setModel(e.target.value)}
|
||||||
className="text-xs h-8"
|
className="text-xs h-8"
|
||||||
@@ -149,7 +218,7 @@ export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
|||||||
<div className="flex gap-2 items-center">
|
<div className="flex gap-2 items-center">
|
||||||
<Input
|
<Input
|
||||||
type={showApiKey ? 'text' : 'password'}
|
type={showApiKey ? 'text' : 'password'}
|
||||||
placeholder="sk-..."
|
// placeholder="sk-..."
|
||||||
value={apiKey}
|
value={apiKey}
|
||||||
onChange={(e) => setApiKey(e.target.value)}
|
onChange={(e) => setApiKey(e.target.value)}
|
||||||
className="text-xs h-8"
|
className="text-xs h-8"
|
||||||
@@ -165,6 +234,75 @@ export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div className="flex flex-col gap-1.5">
|
||||||
|
<label className="text-xs text-muted-foreground">Response Language</label>
|
||||||
|
<select
|
||||||
|
value={language ?? ''}
|
||||||
|
onChange={(e) => setLanguage((e.target.value || undefined) as LanguagePreference)}
|
||||||
|
className="h-8 text-xs rounded-md border border-input bg-background px-2 cursor-pointer"
|
||||||
|
>
|
||||||
|
<option value="">System</option>
|
||||||
|
<option value="en-US">English</option>
|
||||||
|
<option value="zh-CN">中文</option>
|
||||||
|
</select>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* Advanced Config */}
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() => setAdvancedOpen(!advancedOpen)}
|
||||||
|
className="flex items-center gap-1 text-xs text-muted-foreground hover:text-foreground cursor-pointer mt-1 font-bold"
|
||||||
|
>
|
||||||
|
Advanced
|
||||||
|
{advancedOpen ? <FoldVertical className="size-3" /> : <UnfoldVertical className="size-3" />}
|
||||||
|
</button>
|
||||||
|
|
||||||
|
{advancedOpen && (
|
||||||
|
<>
|
||||||
|
<div className="flex flex-col gap-1.5">
|
||||||
|
<label className="text-xs text-muted-foreground">Max Steps</label>
|
||||||
|
<Input
|
||||||
|
type="number"
|
||||||
|
placeholder="40"
|
||||||
|
min={1}
|
||||||
|
max={200}
|
||||||
|
value={maxSteps ?? ''}
|
||||||
|
onChange={(e) => setMaxSteps(e.target.value ? Number(e.target.value) : undefined)}
|
||||||
|
className="text-xs h-8 [&::-webkit-inner-spin-button]:appearance-none [&::-webkit-outer-spin-button]:appearance-none [-moz-appearance:textfield]"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="flex flex-col gap-1.5">
|
||||||
|
<label className="text-xs text-muted-foreground">System Instruction</label>
|
||||||
|
<textarea
|
||||||
|
placeholder="Additional instructions for the agent..."
|
||||||
|
value={systemInstruction}
|
||||||
|
onChange={(e) => setSystemInstruction(e.target.value)}
|
||||||
|
rows={3}
|
||||||
|
className="text-xs rounded-md border border-input bg-background px-3 py-2 resize-y min-h-[60px]"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<label className="flex items-center justify-between cursor-pointer">
|
||||||
|
<span className="text-xs text-muted-foreground">Disable named tool_choice</span>
|
||||||
|
<Switch checked={disableNamedToolChoice} onCheckedChange={setDisableNamedToolChoice} />
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<label className="flex items-center justify-between cursor-pointer">
|
||||||
|
<span className="text-xs text-muted-foreground">Experimental llms.txt support</span>
|
||||||
|
<Switch checked={experimentalLlmsTxt} onCheckedChange={setExperimentalLlmsTxt} />
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<label className="flex items-center justify-between cursor-pointer">
|
||||||
|
<span className="text-xs text-muted-foreground">Experimental include all tabs</span>
|
||||||
|
<Switch
|
||||||
|
checked={experimentalIncludeAllTabs}
|
||||||
|
onCheckedChange={setExperimentalIncludeAllTabs}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
|
||||||
<div className="flex gap-2 mt-2">
|
<div className="flex gap-2 mt-2">
|
||||||
<Button variant="outline" onClick={onClose} className="flex-1 h-8 text-xs cursor-pointer">
|
<Button variant="outline" onClick={onClose} className="flex-1 h-8 text-xs cursor-pointer">
|
||||||
Cancel
|
Cancel
|
||||||
@@ -181,6 +319,10 @@ export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
|||||||
{/* Footer */}
|
{/* Footer */}
|
||||||
<div className="mt-4 mb-4 pt-4 border-t border-border/50 flex gap-2 justify-between text-[10px] text-muted-foreground">
|
<div className="mt-4 mb-4 pt-4 border-t border-border/50 flex gap-2 justify-between text-[10px] text-muted-foreground">
|
||||||
<div className="flex flex-col justify-between">
|
<div className="flex flex-col justify-between">
|
||||||
|
<span>
|
||||||
|
Version <span className="font-mono">v{__VERSION__}</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
<a
|
<a
|
||||||
href="https://github.com/alibaba/page-agent"
|
href="https://github.com/alibaba/page-agent"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
@@ -192,7 +334,9 @@ export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
|||||||
</svg>
|
</svg>
|
||||||
<span>Source Code</span>
|
<span>Source Code</span>
|
||||||
</a>
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="flex flex-col items-end">
|
||||||
<a
|
<a
|
||||||
href="https://alibaba.github.io/page-agent/"
|
href="https://alibaba.github.io/page-agent/"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
@@ -204,24 +348,15 @@ export function ConfigPanel({ config, onSave, onClose }: ConfigPanelProps) {
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
<a
|
<a
|
||||||
href="https://github.com/alibaba/page-agent/blob/main/packages/extension/PRIVACY.md"
|
href="https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
rel="noopener noreferrer"
|
rel="noopener noreferrer"
|
||||||
className="flex items-center gap-1 hover:text-foreground"
|
className="flex items-center gap-1 hover:text-foreground"
|
||||||
>
|
>
|
||||||
<HatGlasses className="size-3" />
|
<HatGlasses className="size-3" />
|
||||||
<span>Privacy Policy</span>
|
<span>Privacy</span>
|
||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="flex flex-col items-end">
|
|
||||||
<span>
|
|
||||||
Extension <span className="font-mono">v{__EXT_VERSION__}</span>
|
|
||||||
</span>
|
|
||||||
<span>
|
|
||||||
PageAgent <span className="font-mono">v{__CORE_VERSION__}</span>
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{/* attribute */}
|
{/* attribute */}
|
||||||
+16
-5
@@ -1,4 +1,4 @@
|
|||||||
import { AlertTriangle, RotateCcw } from 'lucide-react'
|
import { AlertTriangle, Eraser, RotateCcw } from 'lucide-react'
|
||||||
import { Component, type ErrorInfo, type ReactNode } from 'react'
|
import { Component, type ErrorInfo, type ReactNode } from 'react'
|
||||||
|
|
||||||
import { Button } from '@/components/ui/button'
|
import { Button } from '@/components/ui/button'
|
||||||
@@ -27,6 +27,11 @@ export class ErrorBoundary extends Component<Props, State> {
|
|||||||
window.location.reload()
|
window.location.reload()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
handleResetConfig = async () => {
|
||||||
|
await chrome.storage.local.remove(['llmConfig', 'language', 'advancedConfig'])
|
||||||
|
window.location.reload()
|
||||||
|
}
|
||||||
|
|
||||||
render() {
|
render() {
|
||||||
if (!this.state.hasError) {
|
if (!this.state.hasError) {
|
||||||
return this.props.children
|
return this.props.children
|
||||||
@@ -39,10 +44,16 @@ export class ErrorBoundary extends Component<Props, State> {
|
|||||||
<p className="text-sm text-muted-foreground mb-4 max-w-xs">
|
<p className="text-sm text-muted-foreground mb-4 max-w-xs">
|
||||||
{this.state.error?.message || 'An unexpected error occurred'}
|
{this.state.error?.message || 'An unexpected error occurred'}
|
||||||
</p>
|
</p>
|
||||||
<Button variant="outline" size="sm" onClick={this.handleReload}>
|
<div className="flex gap-2">
|
||||||
<RotateCcw className="size-3.5 mr-2" />
|
<Button variant="outline" size="sm" onClick={this.handleResetConfig}>
|
||||||
Reload Panel
|
<Eraser className="size-3.5 mr-2" />
|
||||||
</Button>
|
Reset Config
|
||||||
|
</Button>
|
||||||
|
<Button variant="outline" size="sm" onClick={this.handleReload}>
|
||||||
|
<RotateCcw className="size-3.5 mr-2" />
|
||||||
|
Reload Panel
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
import { ArrowLeft, RotateCcw, Trash2 } from 'lucide-react'
|
||||||
|
import { useEffect, useState } from 'react'
|
||||||
|
|
||||||
|
import { Button } from '@/components/ui/button'
|
||||||
|
import { type SessionRecord, deleteSession, getSession } from '@/lib/db'
|
||||||
|
|
||||||
|
import { EventCard } from './cards'
|
||||||
|
|
||||||
|
export function HistoryDetail({
|
||||||
|
sessionId,
|
||||||
|
onBack,
|
||||||
|
onRerun,
|
||||||
|
}: {
|
||||||
|
sessionId: string
|
||||||
|
onBack: () => void
|
||||||
|
onRerun: (task: string) => void
|
||||||
|
}) {
|
||||||
|
const [session, setSession] = useState<SessionRecord | null>(null)
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
getSession(sessionId).then((s) => setSession(s ?? null))
|
||||||
|
}, [sessionId])
|
||||||
|
|
||||||
|
if (!session) {
|
||||||
|
return (
|
||||||
|
<div className="flex items-center justify-center h-screen text-xs text-muted-foreground">
|
||||||
|
Loading...
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="flex flex-col h-screen bg-background">
|
||||||
|
{/* Header */}
|
||||||
|
<header className="flex items-center gap-2 border-b px-3 py-2">
|
||||||
|
<Button variant="ghost" size="icon-sm" onClick={onBack} className="cursor-pointer">
|
||||||
|
<ArrowLeft className="size-3.5" />
|
||||||
|
</Button>
|
||||||
|
<span className="text-sm font-medium truncate">History</span>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
{/* Task */}
|
||||||
|
<div className="border-b px-3 py-2 bg-muted/30">
|
||||||
|
<div className="text-[10px] text-muted-foreground uppercase tracking-wide">Task</div>
|
||||||
|
<div className="text-xs font-medium" title={session.task}>
|
||||||
|
{session.task}
|
||||||
|
</div>
|
||||||
|
<div className="mt-2 flex items-center gap-2">
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() => onRerun(session.task)}
|
||||||
|
className="flex items-center gap-1 text-[10px] text-muted-foreground hover:text-foreground transition-colors cursor-pointer disabled:opacity-50 disabled:cursor-not-allowed"
|
||||||
|
>
|
||||||
|
<RotateCcw className="size-3" />
|
||||||
|
Run again
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={async () => {
|
||||||
|
await deleteSession(sessionId)
|
||||||
|
onBack()
|
||||||
|
}}
|
||||||
|
className="flex items-center gap-1 text-[10px] text-muted-foreground hover:text-destructive transition-colors cursor-pointer"
|
||||||
|
>
|
||||||
|
<Trash2 className="size-3" />
|
||||||
|
Delete
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* Events (read-only) */}
|
||||||
|
<div className="flex-1 overflow-y-auto p-3 space-y-2">
|
||||||
|
{session.history.map((event, index) => (
|
||||||
|
<EventCard key={index} event={event} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,152 @@
|
|||||||
|
import { ArrowDownToLine, ArrowLeft, CheckCircle, RotateCcw, Trash2, XCircle } from 'lucide-react'
|
||||||
|
import { useCallback, useEffect, useState } from 'react'
|
||||||
|
|
||||||
|
import { Button } from '@/components/ui/button'
|
||||||
|
import { type SessionRecord, clearSessions, deleteSession, listSessions } from '@/lib/db'
|
||||||
|
import { downloadHistoryExport } from '@/lib/history-export'
|
||||||
|
|
||||||
|
function timeAgo(ts: number): string {
|
||||||
|
const seconds = Math.floor((Date.now() - ts) / 1000)
|
||||||
|
if (seconds < 60) return 'just now'
|
||||||
|
const minutes = Math.floor(seconds / 60)
|
||||||
|
if (minutes < 60) return `${minutes}m ago`
|
||||||
|
const hours = Math.floor(minutes / 60)
|
||||||
|
if (hours < 24) return `${hours}h ago`
|
||||||
|
const days = Math.floor(hours / 24)
|
||||||
|
return `${days}d ago`
|
||||||
|
}
|
||||||
|
|
||||||
|
export function HistoryList({
|
||||||
|
onSelect,
|
||||||
|
onBack,
|
||||||
|
onRerun,
|
||||||
|
}: {
|
||||||
|
onSelect: (id: string) => void
|
||||||
|
onBack: () => void
|
||||||
|
onRerun: (task: string) => void
|
||||||
|
}) {
|
||||||
|
const [sessions, setSessions] = useState<SessionRecord[]>([])
|
||||||
|
const [loading, setLoading] = useState(true)
|
||||||
|
|
||||||
|
const load = useCallback(async () => {
|
||||||
|
setSessions(await listSessions())
|
||||||
|
setLoading(false)
|
||||||
|
}, [])
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
load()
|
||||||
|
}, [load])
|
||||||
|
|
||||||
|
const handleDelete = async (e: React.MouseEvent, id: string) => {
|
||||||
|
e.stopPropagation()
|
||||||
|
await deleteSession(id)
|
||||||
|
setSessions((prev) => prev.filter((s) => s.id !== id))
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleExport = (e: React.MouseEvent, session: SessionRecord) => {
|
||||||
|
e.stopPropagation()
|
||||||
|
downloadHistoryExport(session.task, session.createdAt, session.history)
|
||||||
|
}
|
||||||
|
|
||||||
|
const handleRerun = (e: React.MouseEvent, task: string) => {
|
||||||
|
e.stopPropagation()
|
||||||
|
onRerun(task)
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="flex flex-col h-screen bg-background">
|
||||||
|
{/* Header */}
|
||||||
|
<header className="flex items-center gap-2 border-b px-3 py-2">
|
||||||
|
<Button variant="ghost" size="icon-sm" onClick={onBack} className="cursor-pointer">
|
||||||
|
<ArrowLeft className="size-3.5" />
|
||||||
|
</Button>
|
||||||
|
<span className="text-sm font-medium flex-1">History</span>
|
||||||
|
{sessions.length > 0 && (
|
||||||
|
<Button
|
||||||
|
variant="ghost"
|
||||||
|
size="sm"
|
||||||
|
onClick={async () => {
|
||||||
|
await clearSessions()
|
||||||
|
setSessions([])
|
||||||
|
}}
|
||||||
|
className="text-[10px] text-muted-foreground hover:text-destructive cursor-pointer h-6 px-2"
|
||||||
|
>
|
||||||
|
<Trash2 className="size-3 mr-1" />
|
||||||
|
Clear All
|
||||||
|
</Button>
|
||||||
|
)}
|
||||||
|
</header>
|
||||||
|
|
||||||
|
{/* List */}
|
||||||
|
<div className="flex-1 overflow-y-auto">
|
||||||
|
{loading && (
|
||||||
|
<div className="flex items-center justify-center h-32 text-xs text-muted-foreground">
|
||||||
|
Loading...
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{!loading && sessions.length === 0 && (
|
||||||
|
<div className="flex items-center justify-center h-32 text-xs text-muted-foreground">
|
||||||
|
No history yet
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{sessions.map((session) => (
|
||||||
|
<div
|
||||||
|
key={session.id}
|
||||||
|
role="button"
|
||||||
|
tabIndex={0}
|
||||||
|
onClick={() => onSelect(session.id)}
|
||||||
|
className="w-full text-left px-3 py-2.5 border-b hover:bg-muted/50 transition-colors cursor-pointer flex items-start gap-2 group"
|
||||||
|
>
|
||||||
|
{/* Status icon */}
|
||||||
|
{session.status === 'completed' ? (
|
||||||
|
<CheckCircle className="size-3.5 text-green-500 shrink-0 mt-0.5" />
|
||||||
|
) : (
|
||||||
|
<XCircle className="size-3.5 text-destructive shrink-0 mt-0.5" />
|
||||||
|
)}
|
||||||
|
|
||||||
|
{/* Content */}
|
||||||
|
<div className="flex-1 min-w-0">
|
||||||
|
<p className="text-xs font-medium truncate">{session.task}</p>
|
||||||
|
<div className="flex items-center mt-0.5">
|
||||||
|
<p className="text-[10px] text-muted-foreground">
|
||||||
|
{timeAgo(session.createdAt)} · {session.history.length} steps
|
||||||
|
</p>
|
||||||
|
<div className="flex items-center gap-0.5 ml-auto opacity-0 group-hover:opacity-100 transition-opacity">
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={(e) => handleRerun(e, session.task)}
|
||||||
|
className="p-0.5 text-muted-foreground hover:text-foreground transition-colors cursor-pointer"
|
||||||
|
title="Run task again"
|
||||||
|
aria-label={`Run history task again: ${session.task}`}
|
||||||
|
>
|
||||||
|
<RotateCcw className="size-3" />
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={(e) => handleExport(e, session)}
|
||||||
|
className="p-1 text-muted-foreground hover:text-foreground transition-colors cursor-pointer"
|
||||||
|
title="Export history JSON"
|
||||||
|
aria-label={`Export history for ${session.task}`}
|
||||||
|
>
|
||||||
|
<ArrowDownToLine className="size-3" />
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={(e) => handleDelete(e, session.id)}
|
||||||
|
className="p-0.5 text-muted-foreground hover:text-destructive transition-colors cursor-pointer"
|
||||||
|
title="Delete history"
|
||||||
|
aria-label={`Delete history for ${session.task}`}
|
||||||
|
>
|
||||||
|
<Trash2 className="size-3" />
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
+1
-1
@@ -54,7 +54,7 @@ function ResultCard({
|
|||||||
Result: {success ? 'Success' : 'Failed'}
|
Result: {success ? 'Success' : 'Failed'}
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
<p className="text-xs text-[11px] text-muted-foreground pl-5 whitespace-pre-wrap">{text}</p>
|
<p className="text-[12px] text-foreground pl-5 whitespace-pre-wrap">{text}</p>
|
||||||
{children}
|
{children}
|
||||||
</div>
|
</div>
|
||||||
)
|
)
|
||||||
@@ -0,0 +1,153 @@
|
|||||||
|
import type { AgentStatus } from '@page-agent/core'
|
||||||
|
import { Motion } from 'ai-motion'
|
||||||
|
import { BookOpen, Globe } from 'lucide-react'
|
||||||
|
import { useEffect, useRef } from 'react'
|
||||||
|
import { siGithub } from 'simple-icons'
|
||||||
|
|
||||||
|
import { TypingAnimation } from '@/components/ui/typing-animation'
|
||||||
|
import { cn } from '@/lib/utils'
|
||||||
|
|
||||||
|
// Status dot indicator
|
||||||
|
export function StatusDot({ status }: { status: AgentStatus }) {
|
||||||
|
const colorClass = {
|
||||||
|
idle: 'bg-muted-foreground',
|
||||||
|
running: 'bg-blue-500',
|
||||||
|
completed: 'bg-green-500',
|
||||||
|
error: 'bg-destructive',
|
||||||
|
}[status]
|
||||||
|
|
||||||
|
const label = {
|
||||||
|
idle: 'Ready',
|
||||||
|
running: 'Running',
|
||||||
|
completed: 'Done',
|
||||||
|
error: 'Error',
|
||||||
|
}[status]
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="flex items-center gap-1.5 mr-2">
|
||||||
|
<span
|
||||||
|
className={cn('size-2 rounded-full', colorClass, status === 'running' && 'animate-pulse')}
|
||||||
|
/>
|
||||||
|
<span className="text-xs text-muted-foreground">{label}</span>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function Logo({ className }: { className?: string }) {
|
||||||
|
return <img src="/assets/page-agent-256.webp" alt="Page Agent" className={cn('', className)} />
|
||||||
|
}
|
||||||
|
|
||||||
|
// Full-screen ai-motion glow overlay, shown only while running
|
||||||
|
export function MotionOverlay({ active }: { active: boolean }) {
|
||||||
|
const containerRef = useRef<HTMLDivElement>(null)
|
||||||
|
const motionRef = useRef<Motion | null>(null)
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
try {
|
||||||
|
const mode = document.documentElement.classList.contains('dark') ? 'dark' : 'light'
|
||||||
|
const motion = new Motion({
|
||||||
|
mode,
|
||||||
|
borderWidth: 4,
|
||||||
|
borderRadius: 14,
|
||||||
|
glowWidth: mode === 'dark' ? 120 : 60,
|
||||||
|
styles: { position: 'absolute', inset: '0' },
|
||||||
|
})
|
||||||
|
motionRef.current = motion
|
||||||
|
containerRef.current!.appendChild(motion.element)
|
||||||
|
motion.autoResize(containerRef.current!)
|
||||||
|
} catch (e) {
|
||||||
|
console.warn('[MotionOverlay] Motion unavailable:', e)
|
||||||
|
}
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
motionRef.current?.dispose()
|
||||||
|
motionRef.current = null
|
||||||
|
}
|
||||||
|
}, [])
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const motion = motionRef.current
|
||||||
|
if (!motion) return
|
||||||
|
|
||||||
|
let disposed = false
|
||||||
|
if (active) {
|
||||||
|
motion.start()
|
||||||
|
motion.fadeIn()
|
||||||
|
} else {
|
||||||
|
motion.fadeOut().then(() => !disposed && motion.pause())
|
||||||
|
}
|
||||||
|
return () => {
|
||||||
|
disposed = true
|
||||||
|
}
|
||||||
|
}, [active])
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
ref={containerRef}
|
||||||
|
className="pointer-events-none absolute inset-0 z-10 opacity-60 overflow-hidden"
|
||||||
|
style={{ display: active ? undefined : 'none' }}
|
||||||
|
/>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Empty state with logo and breathing glow
|
||||||
|
export function EmptyState() {
|
||||||
|
return (
|
||||||
|
<div className="flex flex-col items-center justify-center h-full gap-4 text-center px-6">
|
||||||
|
<div className="relative select-none pointer-events-none">
|
||||||
|
<div className="absolute inset-0 -m-6 rounded-full bg-[conic-gradient(from_180deg,oklch(0.55_0.2_280),oklch(0.5_0.15_230),oklch(0.6_0.18_310),oklch(0.55_0.2_280))] blur-2xl animate-[glow-a_5s_ease-in-out_infinite]" />
|
||||||
|
<div className="absolute inset-0 -m-6 rounded-full bg-[conic-gradient(from_0deg,oklch(0.55_0.18_160),oklch(0.5_0.2_200),oklch(0.6_0.15_120),oklch(0.55_0.18_160))] blur-2xl animate-[glow-b_5s_ease-in-out_infinite]" />
|
||||||
|
<Logo className="relative size-20 opacity-80" />
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<h2 className="text-base font-medium text-foreground mb-1">Page Agent Ext</h2>
|
||||||
|
<TypingAnimation
|
||||||
|
className="text-sm text-muted-foreground"
|
||||||
|
words={[
|
||||||
|
'Enter a task to automate this page',
|
||||||
|
'Execute multi-page tasks',
|
||||||
|
'Call this extension from your web page',
|
||||||
|
'Use this extension in your own agents',
|
||||||
|
]}
|
||||||
|
cursorStyle="underscore"
|
||||||
|
loop
|
||||||
|
startOnView={false}
|
||||||
|
typeSpeed={20}
|
||||||
|
deleteSpeed={10}
|
||||||
|
pauseDelay={3000}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
<div className="flex items-center gap-3 mt-1 text-muted-foreground">
|
||||||
|
<a
|
||||||
|
href="https://github.com/alibaba/page-agent"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
className="hover:text-foreground transition-colors"
|
||||||
|
title="GitHub"
|
||||||
|
>
|
||||||
|
<svg role="img" viewBox="0 0 24 24" className="size-4 fill-current">
|
||||||
|
<path d={siGithub.path} />
|
||||||
|
</svg>
|
||||||
|
</a>
|
||||||
|
<a
|
||||||
|
href="https://alibaba.github.io/page-agent/docs/features/chrome-extension"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
className="hover:text-foreground transition-colors"
|
||||||
|
title="Documentation"
|
||||||
|
>
|
||||||
|
<BookOpen className="size-4" />
|
||||||
|
</a>
|
||||||
|
<a
|
||||||
|
href="https://alibaba.github.io/page-agent"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
className="hover:text-foreground transition-colors"
|
||||||
|
title="Website"
|
||||||
|
>
|
||||||
|
<Globe className="size-4" />
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -21,8 +21,9 @@ function InputGroup({ className, ...props }: React.ComponentProps<'div'>) {
|
|||||||
'has-[>[data-align=block-start]]:h-auto has-[>[data-align=block-start]]:flex-col has-[>[data-align=block-start]]:[&>input]:pb-3',
|
'has-[>[data-align=block-start]]:h-auto has-[>[data-align=block-start]]:flex-col has-[>[data-align=block-start]]:[&>input]:pb-3',
|
||||||
'has-[>[data-align=block-end]]:h-auto has-[>[data-align=block-end]]:flex-col has-[>[data-align=block-end]]:[&>input]:pt-3',
|
'has-[>[data-align=block-end]]:h-auto has-[>[data-align=block-end]]:flex-col has-[>[data-align=block-end]]:[&>input]:pt-3',
|
||||||
|
|
||||||
// Focus state.
|
// Focus state — soft multi-color glow matching ai-motion palette
|
||||||
'has-[[data-slot=input-group-control]:focus-visible]:border-ring has-[[data-slot=input-group-control]:focus-visible]:ring-ring/50 has-[[data-slot=input-group-control]:focus-visible]:ring-[3px]',
|
'has-[[data-slot=input-group-control]:focus-visible]:border-blue-400/60',
|
||||||
|
'has-[[data-slot=input-group-control]:focus-visible]:shadow-[0_0_0_1px_rgba(57,182,255,0.2),0_0_8px_rgba(57,182,255,0.15),0_0_16px_rgba(189,69,251,0.1)]',
|
||||||
|
|
||||||
// Error state.
|
// Error state.
|
||||||
'has-[[data-slot][aria-invalid=true]]:ring-destructive/20 has-[[data-slot][aria-invalid=true]]:border-destructive dark:has-[[data-slot][aria-invalid=true]]:ring-destructive/40',
|
'has-[[data-slot][aria-invalid=true]]:ring-destructive/20 has-[[data-slot][aria-invalid=true]]:border-destructive dark:has-[[data-slot][aria-invalid=true]]:ring-destructive/40',
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ function Switch({ className, ...props }: React.ComponentProps<typeof SwitchPrimi
|
|||||||
<SwitchPrimitive.Root
|
<SwitchPrimitive.Root
|
||||||
data-slot="switch"
|
data-slot="switch"
|
||||||
className={cn(
|
className={cn(
|
||||||
'peer data-[state=checked]:bg-primary data-[state=unchecked]:bg-input focus-visible:border-ring focus-visible:ring-ring/50 dark:data-[state=unchecked]:bg-input/80 inline-flex h-[1.15rem] w-8 shrink-0 items-center rounded-full border border-transparent shadow-xs transition-all outline-none focus-visible:ring-[3px] disabled:cursor-not-allowed disabled:opacity-50',
|
'peer data-[state=checked]:bg-primary data-[state=unchecked]:bg-input focus-visible:border-ring focus-visible:ring-ring/50 dark:data-[state=unchecked]:bg-input/80 inline-flex h-[1.15rem] w-8 shrink-0 cursor-pointer items-center rounded-full border border-transparent shadow-xs transition-all outline-none focus-visible:ring-[3px] disabled:cursor-not-allowed disabled:opacity-50',
|
||||||
className
|
className
|
||||||
)}
|
)}
|
||||||
{...props}
|
{...props}
|
||||||
|
|||||||
@@ -0,0 +1,164 @@
|
|||||||
|
import { MotionProps, motion, useInView } from 'motion/react'
|
||||||
|
import { useEffect, useMemo, useRef, useState } from 'react'
|
||||||
|
|
||||||
|
import { cn } from '@/lib/utils'
|
||||||
|
|
||||||
|
interface TypingAnimationProps extends MotionProps {
|
||||||
|
children?: string
|
||||||
|
words?: string[]
|
||||||
|
className?: string
|
||||||
|
duration?: number
|
||||||
|
typeSpeed?: number
|
||||||
|
deleteSpeed?: number
|
||||||
|
delay?: number
|
||||||
|
pauseDelay?: number
|
||||||
|
loop?: boolean
|
||||||
|
as?: React.ElementType
|
||||||
|
startOnView?: boolean
|
||||||
|
showCursor?: boolean
|
||||||
|
blinkCursor?: boolean
|
||||||
|
cursorStyle?: 'line' | 'block' | 'underscore'
|
||||||
|
}
|
||||||
|
|
||||||
|
export function TypingAnimation({
|
||||||
|
children,
|
||||||
|
words,
|
||||||
|
className,
|
||||||
|
duration = 100,
|
||||||
|
typeSpeed,
|
||||||
|
deleteSpeed,
|
||||||
|
delay = 0,
|
||||||
|
pauseDelay = 1000,
|
||||||
|
loop = false,
|
||||||
|
as: Component = 'span',
|
||||||
|
startOnView = true,
|
||||||
|
showCursor = true,
|
||||||
|
blinkCursor = true,
|
||||||
|
cursorStyle = 'line',
|
||||||
|
...props
|
||||||
|
}: TypingAnimationProps) {
|
||||||
|
const MotionComponent = motion.create(Component, {
|
||||||
|
forwardMotionProps: true,
|
||||||
|
})
|
||||||
|
|
||||||
|
const [displayedText, setDisplayedText] = useState<string>('')
|
||||||
|
const [currentWordIndex, setCurrentWordIndex] = useState(0)
|
||||||
|
const [currentCharIndex, setCurrentCharIndex] = useState(0)
|
||||||
|
const [phase, setPhase] = useState<'typing' | 'pause' | 'deleting'>('typing')
|
||||||
|
const elementRef = useRef<HTMLElement | null>(null)
|
||||||
|
const isInView = useInView(elementRef as React.RefObject<Element>, {
|
||||||
|
amount: 0.3,
|
||||||
|
once: true,
|
||||||
|
})
|
||||||
|
|
||||||
|
const wordsToAnimate = useMemo(() => words || (children ? [children] : []), [words, children])
|
||||||
|
const hasMultipleWords = wordsToAnimate.length > 1
|
||||||
|
|
||||||
|
const typingSpeed = typeSpeed || duration
|
||||||
|
const deletingSpeed = deleteSpeed || typingSpeed / 2
|
||||||
|
|
||||||
|
const shouldStart = startOnView ? isInView : true
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (!shouldStart || wordsToAnimate.length === 0) return
|
||||||
|
|
||||||
|
const timeoutDelay =
|
||||||
|
delay > 0 && displayedText === ''
|
||||||
|
? delay
|
||||||
|
: phase === 'typing'
|
||||||
|
? typingSpeed
|
||||||
|
: phase === 'deleting'
|
||||||
|
? deletingSpeed
|
||||||
|
: pauseDelay
|
||||||
|
|
||||||
|
const timeout = setTimeout(() => {
|
||||||
|
const currentWord = wordsToAnimate[currentWordIndex] || ''
|
||||||
|
const graphemes = Array.from(currentWord)
|
||||||
|
|
||||||
|
switch (phase) {
|
||||||
|
case 'typing':
|
||||||
|
if (currentCharIndex < graphemes.length) {
|
||||||
|
setDisplayedText(graphemes.slice(0, currentCharIndex + 1).join(''))
|
||||||
|
setCurrentCharIndex(currentCharIndex + 1)
|
||||||
|
} else {
|
||||||
|
if (hasMultipleWords || loop) {
|
||||||
|
const isLastWord = currentWordIndex === wordsToAnimate.length - 1
|
||||||
|
if (!isLastWord || loop) {
|
||||||
|
setPhase('pause')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
break
|
||||||
|
|
||||||
|
case 'pause':
|
||||||
|
setPhase('deleting')
|
||||||
|
break
|
||||||
|
|
||||||
|
case 'deleting':
|
||||||
|
if (currentCharIndex > 0) {
|
||||||
|
setDisplayedText(graphemes.slice(0, currentCharIndex - 1).join(''))
|
||||||
|
setCurrentCharIndex(currentCharIndex - 1)
|
||||||
|
} else {
|
||||||
|
const nextIndex = (currentWordIndex + 1) % wordsToAnimate.length
|
||||||
|
setCurrentWordIndex(nextIndex)
|
||||||
|
setPhase('typing')
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}, timeoutDelay)
|
||||||
|
|
||||||
|
return () => clearTimeout(timeout)
|
||||||
|
}, [
|
||||||
|
shouldStart,
|
||||||
|
phase,
|
||||||
|
currentCharIndex,
|
||||||
|
currentWordIndex,
|
||||||
|
displayedText,
|
||||||
|
wordsToAnimate,
|
||||||
|
hasMultipleWords,
|
||||||
|
loop,
|
||||||
|
typingSpeed,
|
||||||
|
deletingSpeed,
|
||||||
|
pauseDelay,
|
||||||
|
delay,
|
||||||
|
])
|
||||||
|
|
||||||
|
const currentWordGraphemes = Array.from(wordsToAnimate[currentWordIndex] || '')
|
||||||
|
const isComplete =
|
||||||
|
!loop &&
|
||||||
|
currentWordIndex === wordsToAnimate.length - 1 &&
|
||||||
|
currentCharIndex >= currentWordGraphemes.length &&
|
||||||
|
phase !== 'deleting'
|
||||||
|
|
||||||
|
const shouldShowCursor =
|
||||||
|
showCursor &&
|
||||||
|
!isComplete &&
|
||||||
|
(hasMultipleWords || loop || currentCharIndex < currentWordGraphemes.length)
|
||||||
|
|
||||||
|
const getCursorChar = () => {
|
||||||
|
switch (cursorStyle) {
|
||||||
|
case 'block':
|
||||||
|
return '▌'
|
||||||
|
case 'underscore':
|
||||||
|
return '_'
|
||||||
|
case 'line':
|
||||||
|
default:
|
||||||
|
return '|'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<MotionComponent
|
||||||
|
ref={elementRef}
|
||||||
|
className={cn('leading-[5rem] tracking-[-0.02em]', className)}
|
||||||
|
{...props}
|
||||||
|
>
|
||||||
|
{displayedText}
|
||||||
|
{shouldShowCursor && (
|
||||||
|
<span className={cn('inline-block', blinkCursor && 'animate-blink-cursor')}>
|
||||||
|
{getCursorChar()}
|
||||||
|
</span>
|
||||||
|
)}
|
||||||
|
</MotionComponent>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -1,24 +1,13 @@
|
|||||||
import { handlePageControlMessage } from '@/agent/RemotePageController.background'
|
import { handlePageControlMessage } from '@/agent/RemotePageController.background'
|
||||||
import { handleTabControlMessage } from '@/agent/TabsController.background'
|
import { handleTabControlMessage, setupTabEventsPort } from '@/agent/TabsController.background'
|
||||||
|
|
||||||
chrome.runtime.onMessage.addListener((message, sender, sendResponse): true | undefined => {
|
|
||||||
if (message.type === 'TAB_CONTROL') {
|
|
||||||
return handleTabControlMessage(message, sender, sendResponse)
|
|
||||||
} else if (message.type === 'PAGE_CONTROL') {
|
|
||||||
return handlePageControlMessage(message, sender, sendResponse)
|
|
||||||
} else {
|
|
||||||
sendResponse({ error: 'Unknown message type' })
|
|
||||||
return
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
// ============================================================================
|
|
||||||
// Extension Setup
|
|
||||||
// ============================================================================
|
|
||||||
|
|
||||||
export default defineBackground(() => {
|
export default defineBackground(() => {
|
||||||
console.log('[Background] Service Worker started')
|
console.log('[Background] Service Worker started')
|
||||||
|
|
||||||
|
// tab change events
|
||||||
|
|
||||||
|
setupTabEventsPort()
|
||||||
|
|
||||||
// generate user auth token
|
// generate user auth token
|
||||||
|
|
||||||
chrome.storage.local.get('PageAgentExtUserAuthToken').then((result) => {
|
chrome.storage.local.get('PageAgentExtUserAuthToken').then((result) => {
|
||||||
@@ -28,21 +17,47 @@ export default defineBackground(() => {
|
|||||||
chrome.storage.local.set({ PageAgentExtUserAuthToken: userAuthToken })
|
chrome.storage.local.set({ PageAgentExtUserAuthToken: userAuthToken })
|
||||||
})
|
})
|
||||||
|
|
||||||
|
// message proxy
|
||||||
|
|
||||||
|
chrome.runtime.onMessage.addListener((message, sender, sendResponse): true | undefined => {
|
||||||
|
if (message.type === 'TAB_CONTROL') {
|
||||||
|
return handleTabControlMessage(message, sender, sendResponse)
|
||||||
|
} else if (message.type === 'PAGE_CONTROL') {
|
||||||
|
return handlePageControlMessage(message, sender, sendResponse)
|
||||||
|
} else {
|
||||||
|
sendResponse({ error: 'Unknown message type' })
|
||||||
|
return
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// external messages (from localhost launcher page via externally_connectable)
|
||||||
|
|
||||||
|
chrome.runtime.onMessageExternal.addListener((message, sender, sendResponse) => {
|
||||||
|
if (message.type === 'OPEN_HUB') {
|
||||||
|
openOrFocusHubTab(message.wsPort).then(() => {
|
||||||
|
if (sender.tab?.id) chrome.tabs.remove(sender.tab.id)
|
||||||
|
sendResponse({ ok: true })
|
||||||
|
})
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
// setup
|
// setup
|
||||||
|
|
||||||
chrome.sidePanel.setPanelBehavior({ openPanelOnActionClick: true }).catch(() => {})
|
chrome.sidePanel.setPanelBehavior({ openPanelOnActionClick: true }).catch(() => {})
|
||||||
|
|
||||||
// Tab change events
|
|
||||||
|
|
||||||
chrome.tabs.onCreated.addListener((tab) => {
|
|
||||||
chrome.runtime.sendMessage({ type: 'TAB_CHANGE', action: 'created', payload: { tab } })
|
|
||||||
})
|
|
||||||
|
|
||||||
chrome.tabs.onRemoved.addListener((tabId, removeInfo) => {
|
|
||||||
chrome.runtime.sendMessage({
|
|
||||||
type: 'TAB_CHANGE',
|
|
||||||
action: 'removed',
|
|
||||||
payload: { tabId, removeInfo },
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
|
||||||
|
async function openOrFocusHubTab(wsPort: number) {
|
||||||
|
const hubUrl = chrome.runtime.getURL('hub.html')
|
||||||
|
const existing = await chrome.tabs.query({ url: `${hubUrl}*` })
|
||||||
|
|
||||||
|
if (existing.length > 0 && existing[0].id) {
|
||||||
|
await chrome.tabs.update(existing[0].id, {
|
||||||
|
active: true,
|
||||||
|
url: `${hubUrl}?ws=${wsPort}`,
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
await chrome.tabs.create({ url: `${hubUrl}?ws=${wsPort}`, pinned: true })
|
||||||
|
}
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ const DEBUG_PREFIX = '[Content]'
|
|||||||
|
|
||||||
export default defineContentScript({
|
export default defineContentScript({
|
||||||
matches: ['<all_urls>'],
|
matches: ['<all_urls>'],
|
||||||
runAt: 'document_idle',
|
runAt: 'document_end',
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
console.debug(`${DEBUG_PREFIX} Loaded on ${window.location.href}`)
|
console.debug(`${DEBUG_PREFIX} Loaded on ${window.location.href}`)
|
||||||
@@ -46,6 +46,8 @@ async function exposeAgentToPage() {
|
|||||||
let multiPageAgent: InstanceType<typeof MultiPageAgent> | null = null
|
let multiPageAgent: InstanceType<typeof MultiPageAgent> | null = null
|
||||||
|
|
||||||
window.addEventListener('message', async (e) => {
|
window.addEventListener('message', async (e) => {
|
||||||
|
if (e.source !== window) return
|
||||||
|
|
||||||
const data = e.data
|
const data = e.data
|
||||||
if (typeof data !== 'object' || data === null) return
|
if (typeof data !== 'object' || data === null) return
|
||||||
if (data.channel !== 'PAGE_AGENT_EXT_REQUEST') return
|
if (data.channel !== 'PAGE_AGENT_EXT_REQUEST') return
|
||||||
@@ -69,11 +71,16 @@ async function exposeAgentToPage() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const { task, llmConfig } = payload
|
const { task, config } = payload
|
||||||
|
const { systemInstruction, ...agentConfig } = config
|
||||||
|
|
||||||
// create when used
|
// Dispose old instance before creating new one
|
||||||
|
multiPageAgent?.dispose()
|
||||||
|
|
||||||
multiPageAgent = new MultiPageAgent(llmConfig)
|
multiPageAgent = new MultiPageAgent({
|
||||||
|
...agentConfig,
|
||||||
|
instructions: systemInstruction ? { system: systemInstruction } : undefined,
|
||||||
|
})
|
||||||
|
|
||||||
// events
|
// events
|
||||||
|
|
||||||
@@ -116,17 +123,6 @@ async function exposeAgentToPage() {
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
multiPageAgent.addEventListener('dispose', () => {
|
|
||||||
window.postMessage(
|
|
||||||
{
|
|
||||||
channel: 'PAGE_AGENT_EXT_RESPONSE',
|
|
||||||
id,
|
|
||||||
action: 'dispose_event',
|
|
||||||
},
|
|
||||||
'*'
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
// result
|
// result
|
||||||
|
|
||||||
const result = await multiPageAgent.execute(task)
|
const result = await multiPageAgent.execute(task)
|
||||||
@@ -155,9 +151,8 @@ async function exposeAgentToPage() {
|
|||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'dispose': {
|
case 'stop': {
|
||||||
// @note stop ongoing processes but can still be re-used later
|
multiPageAgent?.stop()
|
||||||
multiPageAgent?.dispose()
|
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,250 @@
|
|||||||
|
import { FoldVertical, Plug, PlugZap, Square, UnfoldVertical, Unplug } from 'lucide-react'
|
||||||
|
import { useEffect, useRef, useState } from 'react'
|
||||||
|
|
||||||
|
import { useAgent } from '@/agent/useAgent'
|
||||||
|
import { ActivityCard, EventCard } from '@/components/cards'
|
||||||
|
import { Logo, MotionOverlay, StatusDot } from '@/components/misc'
|
||||||
|
import { Button } from '@/components/ui/button'
|
||||||
|
import { Switch } from '@/components/ui/switch'
|
||||||
|
|
||||||
|
import { useHubWs } from './hub-ws'
|
||||||
|
|
||||||
|
export default function App() {
|
||||||
|
const { status, history, activity, currentTask, config, execute, stop, configure } = useAgent()
|
||||||
|
const { wsState } = useHubWs(execute, stop, configure, config)
|
||||||
|
|
||||||
|
const historyRef = useRef<HTMLDivElement>(null)
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (historyRef.current) {
|
||||||
|
historyRef.current.scrollTop = historyRef.current.scrollHeight
|
||||||
|
}
|
||||||
|
}, [history, activity])
|
||||||
|
|
||||||
|
const isRunning = status === 'running'
|
||||||
|
const WsIcon = wsState === 'connected' ? PlugZap : wsState === 'connecting' ? Plug : Unplug
|
||||||
|
const wsLabel = {
|
||||||
|
connected: 'Connected',
|
||||||
|
connecting: 'Connecting…',
|
||||||
|
disconnected: new URLSearchParams(location.search).get('ws') ? 'Disconnected' : 'No connection',
|
||||||
|
}[wsState]
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="flex h-screen bg-background">
|
||||||
|
{/* Left — Protocol docs */}
|
||||||
|
<aside className="w-80 shrink-0 border-r flex flex-col bg-muted/20">
|
||||||
|
<a
|
||||||
|
href="https://alibaba.github.io/page-agent/"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
className="flex items-center gap-2 px-5 h-12 border-b hover:bg-muted/30 transition-colors"
|
||||||
|
>
|
||||||
|
<Logo className="size-5" />
|
||||||
|
<span className="text-sm font-semibold tracking-tight">Page Agent Hub</span>
|
||||||
|
<span className="text-[9px] font-medium uppercase tracking-wider text-amber-600 bg-amber-500/10 border border-amber-500/30 rounded px-1.5 py-0.5">
|
||||||
|
Beta
|
||||||
|
</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div className="flex-1 overflow-y-auto px-5 py-4 space-y-6">
|
||||||
|
<div className="text-xs text-muted-foreground leading-relaxed space-y-2">
|
||||||
|
<p>
|
||||||
|
Page Agent Hub lets local apps (e.g. MCP servers) control the Page Agent extension via
|
||||||
|
WebSocket.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Check out the official{' '}
|
||||||
|
<a
|
||||||
|
href="https://github.com/alibaba/page-agent/tree/main/packages/mcp"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
className="underline hover:text-foreground"
|
||||||
|
>
|
||||||
|
MCP server package
|
||||||
|
</a>
|
||||||
|
.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<HubConfig />
|
||||||
|
|
||||||
|
<ProtocolDocsCollapsible />
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="border-t px-5 py-3 text-[10px] text-muted-foreground/60 flex items-center justify-between">
|
||||||
|
<span className="font-mono">v{__VERSION__}</span>
|
||||||
|
<span>
|
||||||
|
Built with ♥️ by{' '}
|
||||||
|
<a
|
||||||
|
href="https://github.com/gaomeng1900"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
className="underline hover:text-foreground"
|
||||||
|
>
|
||||||
|
@Simon
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
{/* Right — Live session */}
|
||||||
|
<main className="flex-1 flex flex-col min-w-0 relative">
|
||||||
|
<MotionOverlay active={isRunning} />
|
||||||
|
|
||||||
|
<header className="flex items-center justify-between border-b px-5 h-12">
|
||||||
|
<div className="flex items-center gap-2 text-xs text-muted-foreground">
|
||||||
|
<WsIcon className="size-3.5" />
|
||||||
|
<span>{wsLabel}</span>
|
||||||
|
</div>
|
||||||
|
<div className="flex items-center gap-3">
|
||||||
|
<StatusDot status={status} />
|
||||||
|
{isRunning && (
|
||||||
|
<Button variant="destructive" size="sm" onClick={stop} className="h-7 text-xs">
|
||||||
|
<Square className="size-3 mr-1" />
|
||||||
|
Stop
|
||||||
|
</Button>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
{/* Task banner */}
|
||||||
|
{currentTask && (
|
||||||
|
<div className="border-b px-5 py-2 bg-muted/30">
|
||||||
|
<div className="text-[10px] text-muted-foreground uppercase tracking-wide">
|
||||||
|
Current Task
|
||||||
|
</div>
|
||||||
|
<div className="text-sm font-medium truncate" title={currentTask}>
|
||||||
|
{currentTask}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{/* Event stream */}
|
||||||
|
<div ref={historyRef} className="flex-1 overflow-y-auto p-5 space-y-2">
|
||||||
|
{!currentTask && history.length === 0 && !isRunning && (
|
||||||
|
<div className="flex flex-col items-center justify-center h-full text-muted-foreground gap-3">
|
||||||
|
<WsIcon className="size-10 opacity-30" />
|
||||||
|
<p className="text-sm">
|
||||||
|
{wsState === 'connected'
|
||||||
|
? 'Waiting for task from external caller…'
|
||||||
|
: 'No active session'}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{history.map((event, index) => (
|
||||||
|
<EventCard key={index} event={event} />
|
||||||
|
))}
|
||||||
|
|
||||||
|
{activity && <ActivityCard activity={activity} />}
|
||||||
|
</div>
|
||||||
|
</main>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
function HubConfig() {
|
||||||
|
const [allowAll, setAllowAll] = useState(false)
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
chrome.storage.local.get('allowAllHubConnection').then((r) => {
|
||||||
|
setAllowAll(r.allowAllHubConnection === true)
|
||||||
|
})
|
||||||
|
}, [])
|
||||||
|
|
||||||
|
const toggle = (checked: boolean) => {
|
||||||
|
setAllowAll(checked)
|
||||||
|
chrome.storage.local.set({ allowAllHubConnection: checked })
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
<h3 className="text-[11px] font-semibold text-foreground/80 uppercase tracking-wider mb-2">
|
||||||
|
Config
|
||||||
|
</h3>
|
||||||
|
<div className="group/hub relative">
|
||||||
|
<label
|
||||||
|
className={`flex items-center justify-between p-3 rounded-md border cursor-pointer text-xs ${allowAll ? 'bg-amber-500/10 border-amber-500/30 text-amber-600' : 'bg-muted/50 text-muted-foreground'}`}
|
||||||
|
>
|
||||||
|
Auto-approve connections
|
||||||
|
<Switch
|
||||||
|
checked={allowAll}
|
||||||
|
onCheckedChange={toggle}
|
||||||
|
className={allowAll ? 'data-[state=checked]:bg-amber-500' : ''}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
|
||||||
|
{/* hide with invisible absolute opacity-0*/}
|
||||||
|
<div className="group-hover/hub:visible group-hover/hub:opacity-100 transition-opacity duration-150 left-0 right-0 top-full z-10 pt-2">
|
||||||
|
<div className="relative p-2.5 rounded-md border border-border bg-background/60 backdrop-blur-md shadow-2xl text-muted-foreground text-xs leading-relaxed">
|
||||||
|
<div className="absolute -top-1.5 left-5 size-3 rotate-45 rounded-[1px] border-l border-t border-border bg-background/60 backdrop-blur-md" />
|
||||||
|
By default, each connection requires your approval before running tasks. <br />
|
||||||
|
Enable this to skip per-session approval.
|
||||||
|
<br />
|
||||||
|
<span className="font-semibold">* Use with caution!</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
function ProtocolDocsCollapsible() {
|
||||||
|
const [open, setOpen] = useState(false)
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() => setOpen(!open)}
|
||||||
|
className="flex items-center gap-1 text-[11px] font-semibold text-foreground/80 uppercase tracking-wider cursor-pointer"
|
||||||
|
>
|
||||||
|
Docs
|
||||||
|
{open ? <FoldVertical className="size-3" /> : <UnfoldVertical className="size-3" />}
|
||||||
|
</button>
|
||||||
|
|
||||||
|
{open && (
|
||||||
|
<div className="mt-3 space-y-4 text-xs text-muted-foreground">
|
||||||
|
<p className="text-[10px]">
|
||||||
|
Connect via <code className="text-[10px]">hub.html?ws=PORT</code>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<h4 className="text-[11px] font-medium text-foreground/60 mb-1.5">Flow</h4>
|
||||||
|
<ol className="list-decimal list-inside space-y-1 text-[11px] leading-relaxed">
|
||||||
|
<li>Hub opens WS to caller's server</li>
|
||||||
|
<li>
|
||||||
|
Sends <code className="text-[10px]">ready</code>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Caller sends <code className="text-[10px]">execute</code> with task
|
||||||
|
</li>
|
||||||
|
<li>Hub runs agent, streams events</li>
|
||||||
|
<li>
|
||||||
|
Hub sends <code className="text-[10px]">result</code> or{' '}
|
||||||
|
<code className="text-[10px]">error</code>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<h4 className="text-[11px] font-medium text-foreground/60 mb-1.5">Caller → Hub</h4>
|
||||||
|
<pre className="bg-muted/50 rounded-md p-3 font-mono text-[10px] leading-relaxed whitespace-pre-wrap">
|
||||||
|
{`{ type: "execute", task: string, config?: object }
|
||||||
|
{ type: "stop" }`}
|
||||||
|
</pre>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<h4 className="text-[11px] font-medium text-foreground/60 mb-1.5">Hub → Caller</h4>
|
||||||
|
<pre className="bg-muted/50 rounded-md p-3 font-mono text-[10px] leading-relaxed whitespace-pre-wrap">
|
||||||
|
{`{ type: "ready" }
|
||||||
|
{ type: "result", success: boolean, data: string }
|
||||||
|
{ type: "error", message: string }`}
|
||||||
|
</pre>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,243 @@
|
|||||||
|
/**
|
||||||
|
* Hub WebSocket Protocol
|
||||||
|
*
|
||||||
|
* Hub connects as WS client to `ws://localhost:{port}`.
|
||||||
|
* All messages are JSON. One task at a time.
|
||||||
|
*
|
||||||
|
* Inbound (Caller → Hub):
|
||||||
|
* { type: "execute", task: string, config?: object }
|
||||||
|
* { type: "stop" }
|
||||||
|
*
|
||||||
|
* Outbound (Hub → Caller):
|
||||||
|
* { type: "ready" }
|
||||||
|
* { type: "result", success: boolean, data: string }
|
||||||
|
* { type: "error", message: string }
|
||||||
|
*/
|
||||||
|
import type { ExecutionResult } from '@page-agent/core'
|
||||||
|
import { useEffect, useRef, useState } from 'react'
|
||||||
|
|
||||||
|
import type { ExtConfig } from '@/agent/useAgent'
|
||||||
|
|
||||||
|
// --- Protocol types ---
|
||||||
|
|
||||||
|
interface ExecuteMessage {
|
||||||
|
type: 'execute'
|
||||||
|
task: string
|
||||||
|
config?: Record<string, unknown>
|
||||||
|
}
|
||||||
|
|
||||||
|
interface StopMessage {
|
||||||
|
type: 'stop'
|
||||||
|
}
|
||||||
|
|
||||||
|
type InboundMessage = ExecuteMessage | StopMessage
|
||||||
|
|
||||||
|
interface ReadyMessage {
|
||||||
|
type: 'ready'
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ResultMessage {
|
||||||
|
type: 'result'
|
||||||
|
success: boolean
|
||||||
|
data: string
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ErrorMessage {
|
||||||
|
type: 'error'
|
||||||
|
message: string
|
||||||
|
}
|
||||||
|
|
||||||
|
type OutboundMessage = ReadyMessage | ResultMessage | ErrorMessage
|
||||||
|
|
||||||
|
export type HubWsState = 'connecting' | 'connected' | 'disconnected'
|
||||||
|
|
||||||
|
// --- HubWs class ---
|
||||||
|
|
||||||
|
export interface HubWsHandlers {
|
||||||
|
onExecute: (
|
||||||
|
task: string,
|
||||||
|
config?: Record<string, unknown>
|
||||||
|
) => Promise<{ success: boolean; data: string }>
|
||||||
|
onStop: () => void
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Framework-agnostic WebSocket client for Hub.
|
||||||
|
* Connects to an external WS server, receives tasks, dispatches to handlers,
|
||||||
|
* and sends results back. No React, no DOM.
|
||||||
|
*/
|
||||||
|
export class HubWs {
|
||||||
|
#ws: WebSocket | null = null
|
||||||
|
#state: HubWsState = 'disconnected'
|
||||||
|
#busy = false
|
||||||
|
#approved = false
|
||||||
|
#handlers: HubWsHandlers
|
||||||
|
#port: number
|
||||||
|
#onStateChange: (state: HubWsState) => void
|
||||||
|
|
||||||
|
constructor(port: number, handlers: HubWsHandlers, onStateChange: (state: HubWsState) => void) {
|
||||||
|
this.#port = port
|
||||||
|
this.#handlers = handlers
|
||||||
|
this.#onStateChange = onStateChange
|
||||||
|
}
|
||||||
|
|
||||||
|
get state() {
|
||||||
|
return this.#state
|
||||||
|
}
|
||||||
|
|
||||||
|
get busy() {
|
||||||
|
return this.#busy
|
||||||
|
}
|
||||||
|
|
||||||
|
connect() {
|
||||||
|
if (this.#ws) return
|
||||||
|
this.#setState('connecting')
|
||||||
|
|
||||||
|
const ws = new WebSocket(`ws://localhost:${this.#port}`)
|
||||||
|
this.#ws = ws
|
||||||
|
|
||||||
|
ws.addEventListener('open', () => {
|
||||||
|
this.#setState('connected')
|
||||||
|
this.#send({ type: 'ready' })
|
||||||
|
})
|
||||||
|
|
||||||
|
ws.addEventListener('close', () => {
|
||||||
|
this.#ws = null
|
||||||
|
this.#busy = false
|
||||||
|
this.#approved = false
|
||||||
|
this.#setState('disconnected')
|
||||||
|
})
|
||||||
|
|
||||||
|
ws.addEventListener('message', (event) => {
|
||||||
|
this.#handleMessage(event.data as string)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
disconnect() {
|
||||||
|
this.#ws?.close()
|
||||||
|
this.#ws = null
|
||||||
|
this.#busy = false
|
||||||
|
this.#approved = false
|
||||||
|
this.#setState('disconnected')
|
||||||
|
}
|
||||||
|
|
||||||
|
#setState(state: HubWsState) {
|
||||||
|
if (this.#state === state) return
|
||||||
|
this.#state = state
|
||||||
|
this.#onStateChange(state)
|
||||||
|
}
|
||||||
|
|
||||||
|
#send(msg: OutboundMessage) {
|
||||||
|
if (this.#ws?.readyState === WebSocket.OPEN) {
|
||||||
|
this.#ws.send(JSON.stringify(msg))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async #handleMessage(raw: string) {
|
||||||
|
let msg: InboundMessage
|
||||||
|
try {
|
||||||
|
msg = JSON.parse(raw)
|
||||||
|
} catch {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!(await this.#checkApproval())) {
|
||||||
|
this.#send({ type: 'error', message: 'User denied the connection request.' })
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
switch (msg.type) {
|
||||||
|
case 'execute':
|
||||||
|
this.#handleExecute(msg)
|
||||||
|
break
|
||||||
|
case 'stop':
|
||||||
|
this.#handlers.onStop()
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async #checkApproval(): Promise<boolean> {
|
||||||
|
if (this.#approved) return true
|
||||||
|
|
||||||
|
const { allowAllHubConnection } = await chrome.storage.local.get('allowAllHubConnection')
|
||||||
|
if (allowAllHubConnection === true) {
|
||||||
|
this.#approved = true
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
const ok = window.confirm(
|
||||||
|
'An external application is requesting to control your browser via Page Agent Ext.\nAllow this session?'
|
||||||
|
)
|
||||||
|
if (ok) this.#approved = true
|
||||||
|
return ok
|
||||||
|
}
|
||||||
|
|
||||||
|
async #handleExecute(msg: ExecuteMessage) {
|
||||||
|
if (this.#busy) {
|
||||||
|
this.#send({ type: 'error', message: 'Hub is busy with another task' })
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
this.#busy = true
|
||||||
|
try {
|
||||||
|
const result = await this.#handlers.onExecute(msg.task, msg.config)
|
||||||
|
this.#send({ type: 'result', success: result.success, data: result.data })
|
||||||
|
} catch (err) {
|
||||||
|
this.#send({ type: 'error', message: err instanceof Error ? err.message : String(err) })
|
||||||
|
} finally {
|
||||||
|
this.#busy = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- React hook ---
|
||||||
|
|
||||||
|
/**
|
||||||
|
* React hook that bridges HubWs to the agent's execute/stop/configure.
|
||||||
|
* Handles the config-before-execute dance internally.
|
||||||
|
*/
|
||||||
|
export function useHubWs(
|
||||||
|
execute: (task: string) => Promise<ExecutionResult>,
|
||||||
|
stop: () => void,
|
||||||
|
configure: (config: ExtConfig) => Promise<void>,
|
||||||
|
config: ExtConfig | null
|
||||||
|
): { wsState: HubWsState } {
|
||||||
|
const wsPort = new URLSearchParams(location.search).get('ws')
|
||||||
|
const [wsState, setWsState] = useState<HubWsState>(() => (wsPort ? 'connecting' : 'disconnected'))
|
||||||
|
const hubWsRef = useRef<HubWs | null>(null)
|
||||||
|
|
||||||
|
const latestRef = useRef({ execute, stop, configure, config })
|
||||||
|
useEffect(() => {
|
||||||
|
latestRef.current = { execute, stop, configure, config }
|
||||||
|
})
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (!wsPort) return
|
||||||
|
|
||||||
|
const hubWs = new HubWs(
|
||||||
|
Number(wsPort),
|
||||||
|
{
|
||||||
|
onExecute: async (task, incomingConfig) => {
|
||||||
|
const { execute, configure, config } = latestRef.current
|
||||||
|
if (incomingConfig) {
|
||||||
|
await configure({ ...config, ...incomingConfig } as ExtConfig)
|
||||||
|
}
|
||||||
|
const result = await execute(task)
|
||||||
|
return { success: result.success, data: result.data }
|
||||||
|
},
|
||||||
|
onStop: () => latestRef.current.stop(),
|
||||||
|
},
|
||||||
|
setWsState
|
||||||
|
)
|
||||||
|
|
||||||
|
hubWs.connect()
|
||||||
|
hubWsRef.current = hubWs
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
hubWs.disconnect()
|
||||||
|
hubWsRef.current = null
|
||||||
|
}
|
||||||
|
}, [wsPort])
|
||||||
|
|
||||||
|
return { wsState }
|
||||||
|
}
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<link rel="icon" type="image/png" href="/assets/page-agent-64.png" />
|
||||||
|
<title>Page Agent Hub</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="root"></div>
|
||||||
|
<script type="module" src="./main.tsx"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
import React from 'react'
|
||||||
|
import ReactDOM from 'react-dom/client'
|
||||||
|
|
||||||
|
import { ErrorBoundary } from '@/components/ErrorBoundary'
|
||||||
|
|
||||||
|
import App from './App'
|
||||||
|
|
||||||
|
import '@/assets/index.css'
|
||||||
|
|
||||||
|
const syncDarkMode = () => {
|
||||||
|
document.documentElement.classList.toggle(
|
||||||
|
'dark',
|
||||||
|
matchMedia('(prefers-color-scheme: dark)').matches
|
||||||
|
)
|
||||||
|
}
|
||||||
|
syncDarkMode()
|
||||||
|
matchMedia('(prefers-color-scheme: dark)').addEventListener('change', syncDarkMode)
|
||||||
|
|
||||||
|
ReactDOM.createRoot(document.getElementById('root')!).render(
|
||||||
|
<React.StrictMode>
|
||||||
|
<ErrorBoundary>
|
||||||
|
<App />
|
||||||
|
</ErrorBoundary>
|
||||||
|
</React.StrictMode>
|
||||||
|
)
|
||||||
@@ -1,19 +1,32 @@
|
|||||||
import type { AgentActivity, AgentStatus, ExecutionResult, HistoricalEvent } from '@page-agent/core'
|
import type { AgentActivity, AgentStatus, ExecutionResult, HistoricalEvent } from '@page-agent/core'
|
||||||
import type { LLMConfig } from '@page-agent/llms'
|
|
||||||
|
|
||||||
export interface ExecuteHooks {
|
export type Execute = (task: string, config: ExecuteConfig) => Promise<ExecutionResult>
|
||||||
|
|
||||||
|
export interface ExecuteConfig {
|
||||||
|
baseURL: string
|
||||||
|
model: string
|
||||||
|
apiKey?: string
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Global system-level instructions for the agent.
|
||||||
|
* Equivalent to `AgentConfig.instructions.system`.
|
||||||
|
*/
|
||||||
|
systemInstruction?: string
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to include the initial tab (that holds this main world script) in the task.
|
||||||
|
* @default true
|
||||||
|
*/
|
||||||
|
includeInitialTab?: boolean
|
||||||
|
|
||||||
|
/** Control all unpinned tabs in the window instead of only the tab group. */
|
||||||
|
experimentalIncludeAllTabs?: boolean
|
||||||
|
|
||||||
onStatusChange?: (status: AgentStatus) => void
|
onStatusChange?: (status: AgentStatus) => void
|
||||||
onActivity?: (activity: AgentActivity) => void
|
onActivity?: (activity: AgentActivity) => void
|
||||||
onHistoryUpdate?: (history: HistoricalEvent[]) => void
|
onHistoryUpdate?: (history: HistoricalEvent[]) => void
|
||||||
onDispose?: () => void
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export type Execute = (
|
|
||||||
task: string,
|
|
||||||
llmConfig: LLMConfig,
|
|
||||||
hooks?: ExecuteHooks
|
|
||||||
) => Promise<ExecutionResult>
|
|
||||||
|
|
||||||
export default defineUnlistedScript(() => {
|
export default defineUnlistedScript(() => {
|
||||||
let _lastId = 0
|
let _lastId = 0
|
||||||
function getId() {
|
function getId() {
|
||||||
@@ -21,18 +34,19 @@ export default defineUnlistedScript(() => {
|
|||||||
return _lastId
|
return _lastId
|
||||||
}
|
}
|
||||||
|
|
||||||
const execute: Execute = async (task, llmConfig, hooks) => {
|
const execute: Execute = async (task, config) => {
|
||||||
if (typeof task !== 'string') throw new Error('Task must be a string')
|
if (typeof task !== 'string') throw new Error('Task must be a string')
|
||||||
if (task.trim().length === 0) throw new Error('Task cannot be empty')
|
if (task.trim().length === 0) throw new Error('Task cannot be empty')
|
||||||
if (!llmConfig) throw new Error('LLM config is required')
|
if (!config) throw new Error('Config is required')
|
||||||
if (!llmConfig.baseURL) throw new Error('LLM config must have a baseURL')
|
if (!config.baseURL) throw new Error('Config must have a baseURL')
|
||||||
if (!llmConfig.apiKey) throw new Error('LLM config must have an apiKey')
|
if (!config.model) throw new Error('Config must have a model')
|
||||||
if (!llmConfig.model) throw new Error('LLM config must have a model')
|
|
||||||
|
|
||||||
const id = getId()
|
const id = getId()
|
||||||
|
|
||||||
const promise = new Promise<ExecutionResult>((resolve, reject) => {
|
const promise = new Promise<ExecutionResult>((resolve, reject) => {
|
||||||
function handleMessage(e: MessageEvent) {
|
function handleMessage(e: MessageEvent) {
|
||||||
|
if (e.source !== window) return
|
||||||
|
|
||||||
const data = e.data
|
const data = e.data
|
||||||
if (typeof data !== 'object' || data === null) return
|
if (typeof data !== 'object' || data === null) return
|
||||||
if (data.channel !== 'PAGE_AGENT_EXT_RESPONSE') return
|
if (data.channel !== 'PAGE_AGENT_EXT_RESPONSE') return
|
||||||
@@ -40,30 +54,25 @@ export default defineUnlistedScript(() => {
|
|||||||
|
|
||||||
// events
|
// events
|
||||||
|
|
||||||
if (data.action === 'status_change_event' && hooks?.onStatusChange) {
|
if (data.action === 'status_change_event' && config.onStatusChange) {
|
||||||
hooks.onStatusChange(data.payload)
|
config.onStatusChange(data.payload)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if (data.action === 'activity_event' && hooks?.onActivity) {
|
if (data.action === 'activity_event' && config.onActivity) {
|
||||||
hooks.onActivity(data.payload)
|
config.onActivity(data.payload)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if (data.action === 'history_change_event' && hooks?.onHistoryUpdate) {
|
if (data.action === 'history_change_event' && config.onHistoryUpdate) {
|
||||||
hooks.onHistoryUpdate(data.payload)
|
config.onHistoryUpdate(data.payload)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if (data.action === 'dispose_event' && hooks?.onDispose) {
|
|
||||||
hooks.onDispose()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// result
|
|
||||||
|
|
||||||
if (data.action !== 'execute_result') return
|
if (data.action !== 'execute_result') return
|
||||||
|
|
||||||
|
// execute_result
|
||||||
|
|
||||||
window.removeEventListener('message', handleMessage)
|
window.removeEventListener('message', handleMessage)
|
||||||
|
|
||||||
if (data.error) {
|
if (data.error) {
|
||||||
@@ -73,6 +82,7 @@ export default defineUnlistedScript(() => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// @note will be removed on dispose or result
|
||||||
window.addEventListener('message', handleMessage)
|
window.addEventListener('message', handleMessage)
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -81,7 +91,17 @@ export default defineUnlistedScript(() => {
|
|||||||
channel: 'PAGE_AGENT_EXT_REQUEST',
|
channel: 'PAGE_AGENT_EXT_REQUEST',
|
||||||
id,
|
id,
|
||||||
action: 'execute',
|
action: 'execute',
|
||||||
payload: { task, llmConfig },
|
payload: {
|
||||||
|
task,
|
||||||
|
config: {
|
||||||
|
baseURL: config.baseURL,
|
||||||
|
model: config.model,
|
||||||
|
apiKey: config.apiKey,
|
||||||
|
systemInstruction: config.systemInstruction,
|
||||||
|
includeInitialTab: config.includeInitialTab,
|
||||||
|
experimentalIncludeAllTabs: config.experimentalIncludeAllTabs,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
'*'
|
'*'
|
||||||
)
|
)
|
||||||
@@ -89,23 +109,23 @@ export default defineUnlistedScript(() => {
|
|||||||
return promise
|
return promise
|
||||||
}
|
}
|
||||||
|
|
||||||
const dispose = () => {
|
const stop = () => {
|
||||||
const id = getId()
|
const id = getId()
|
||||||
|
|
||||||
window.postMessage(
|
window.postMessage(
|
||||||
{
|
{
|
||||||
channel: 'PAGE_AGENT_EXT_REQUEST',
|
channel: 'PAGE_AGENT_EXT_REQUEST',
|
||||||
id,
|
id,
|
||||||
action: 'dispose',
|
action: 'stop',
|
||||||
},
|
},
|
||||||
'*'
|
'*'
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
;(window as any).PAGE_AGENT_EXT_VERSION = __EXT_VERSION__
|
;(window as any).PAGE_AGENT_EXT_VERSION = __VERSION__
|
||||||
;(window as any).PAGE_AGENT_EXT = {
|
;(window as any).PAGE_AGENT_EXT = {
|
||||||
version: __EXT_VERSION__,
|
version: __VERSION__,
|
||||||
execute,
|
execute,
|
||||||
dispose,
|
stop,
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,6 +1,11 @@
|
|||||||
import { Send, Settings, Square } from 'lucide-react'
|
import { History, Send, Settings, Square } from 'lucide-react'
|
||||||
import { useCallback, useEffect, useRef, useState } from 'react'
|
import { useCallback, useEffect, useRef, useState } from 'react'
|
||||||
|
|
||||||
|
import { ConfigPanel } from '@/components/ConfigPanel'
|
||||||
|
import { HistoryDetail } from '@/components/HistoryDetail'
|
||||||
|
import { HistoryList } from '@/components/HistoryList'
|
||||||
|
import { ActivityCard, EventCard } from '@/components/cards'
|
||||||
|
import { EmptyState, Logo, MotionOverlay, StatusDot } from '@/components/misc'
|
||||||
import { Button } from '@/components/ui/button'
|
import { Button } from '@/components/ui/button'
|
||||||
import {
|
import {
|
||||||
InputGroup,
|
InputGroup,
|
||||||
@@ -8,20 +13,42 @@ import {
|
|||||||
InputGroupButton,
|
InputGroupButton,
|
||||||
InputGroupTextarea,
|
InputGroupTextarea,
|
||||||
} from '@/components/ui/input-group'
|
} from '@/components/ui/input-group'
|
||||||
|
import { saveSession } from '@/lib/db'
|
||||||
|
|
||||||
import { useAgent } from '../../agent/useAgent'
|
import { useAgent } from '../../agent/useAgent'
|
||||||
import { ConfigPanel } from './components/ConfigPanel'
|
|
||||||
import { ActivityCard, EventCard } from './components/cards'
|
type View =
|
||||||
import { EmptyState, Logo, StatusDot } from './components/misc'
|
| { name: 'chat' }
|
||||||
|
| { name: 'config' }
|
||||||
|
| { name: 'history' }
|
||||||
|
| { name: 'history-detail'; sessionId: string }
|
||||||
|
|
||||||
export default function App() {
|
export default function App() {
|
||||||
const [showConfig, setShowConfig] = useState(false)
|
const [view, setView] = useState<View>({ name: 'chat' })
|
||||||
const [inputValue, setInputValue] = useState('')
|
const [inputValue, setInputValue] = useState('')
|
||||||
const historyRef = useRef<HTMLDivElement>(null)
|
const historyRef = useRef<HTMLDivElement>(null)
|
||||||
const textareaRef = useRef<HTMLTextAreaElement>(null)
|
const textareaRef = useRef<HTMLTextAreaElement>(null)
|
||||||
|
|
||||||
const { status, history, activity, currentTask, config, execute, stop, configure } = useAgent()
|
const { status, history, activity, currentTask, config, execute, stop, configure } = useAgent()
|
||||||
|
|
||||||
|
// Persist session when task finishes
|
||||||
|
const prevStatusRef = useRef(status)
|
||||||
|
useEffect(() => {
|
||||||
|
const prev = prevStatusRef.current
|
||||||
|
prevStatusRef.current = status
|
||||||
|
|
||||||
|
if (
|
||||||
|
prev === 'running' &&
|
||||||
|
(status === 'completed' || status === 'error') &&
|
||||||
|
history.length > 0 &&
|
||||||
|
currentTask
|
||||||
|
) {
|
||||||
|
saveSession({ task: currentTask, history, status }).catch((err) =>
|
||||||
|
console.error('[SidePanel] Failed to save session:', err)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}, [status, history, currentTask])
|
||||||
|
|
||||||
// Auto-scroll to bottom on new events
|
// Auto-scroll to bottom on new events
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (historyRef.current) {
|
if (historyRef.current) {
|
||||||
@@ -29,19 +56,27 @@ export default function App() {
|
|||||||
}
|
}
|
||||||
}, [history, activity])
|
}, [history, activity])
|
||||||
|
|
||||||
const handleSubmit = useCallback(
|
const runTask = useCallback(
|
||||||
(e?: React.SyntheticEvent) => {
|
(task: string) => {
|
||||||
e?.preventDefault()
|
const normalizedTask = task.trim()
|
||||||
if (!inputValue.trim() || status === 'running') return
|
if (!normalizedTask || status === 'running') return
|
||||||
|
|
||||||
const taskToExecute = inputValue.trim()
|
|
||||||
setInputValue('')
|
setInputValue('')
|
||||||
|
setView({ name: 'chat' })
|
||||||
|
|
||||||
execute(taskToExecute).catch((error) => {
|
execute(normalizedTask).catch((error) => {
|
||||||
console.error('[SidePanel] Failed to execute task:', error)
|
console.error('[SidePanel] Failed to execute task:', error)
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
[inputValue, status, execute]
|
[execute, status]
|
||||||
|
)
|
||||||
|
|
||||||
|
const handleSubmit = useCallback(
|
||||||
|
(e?: React.SyntheticEvent) => {
|
||||||
|
e?.preventDefault()
|
||||||
|
runTask(inputValue)
|
||||||
|
},
|
||||||
|
[inputValue, runTask]
|
||||||
)
|
)
|
||||||
|
|
||||||
const handleStop = useCallback(() => {
|
const handleStop = useCallback(() => {
|
||||||
@@ -56,36 +91,69 @@ export default function App() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (showConfig) {
|
// --- View routing ---
|
||||||
|
|
||||||
|
if (view.name === 'config') {
|
||||||
return (
|
return (
|
||||||
<ConfigPanel
|
<ConfigPanel
|
||||||
config={config}
|
config={config}
|
||||||
onSave={async (newConfig) => {
|
onSave={async (newConfig) => {
|
||||||
await configure(newConfig)
|
await configure(newConfig)
|
||||||
setShowConfig(false)
|
setView({ name: 'chat' })
|
||||||
}}
|
}}
|
||||||
onClose={() => setShowConfig(false)}
|
onClose={() => setView({ name: 'chat' })}
|
||||||
/>
|
/>
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (view.name === 'history') {
|
||||||
|
return (
|
||||||
|
<HistoryList
|
||||||
|
onSelect={(id) => setView({ name: 'history-detail', sessionId: id })}
|
||||||
|
onBack={() => setView({ name: 'chat' })}
|
||||||
|
onRerun={runTask}
|
||||||
|
/>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (view.name === 'history-detail') {
|
||||||
|
return (
|
||||||
|
<HistoryDetail
|
||||||
|
sessionId={view.sessionId}
|
||||||
|
onBack={() => setView({ name: 'history' })}
|
||||||
|
onRerun={runTask}
|
||||||
|
/>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Chat view ---
|
||||||
|
|
||||||
const isRunning = status === 'running'
|
const isRunning = status === 'running'
|
||||||
const showEmptyState = !currentTask && history.length === 0 && !isRunning
|
const showEmptyState = !currentTask && history.length === 0 && !isRunning
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="flex flex-col h-screen bg-background">
|
<div className="relative flex flex-col h-screen bg-background">
|
||||||
|
<MotionOverlay active={isRunning} />
|
||||||
{/* Header */}
|
{/* Header */}
|
||||||
<header className="flex items-center justify-between border-b px-3 py-2">
|
<header className="flex items-center justify-between border-b px-3 py-2">
|
||||||
<div className="flex items-center gap-2">
|
<div className="flex items-center gap-2">
|
||||||
<Logo className="size-5" />
|
<Logo className="size-5" />
|
||||||
<span className="text-sm font-medium">Page Agent Ext</span>
|
<span className="text-sm font-medium">Page Agent Ext</span>
|
||||||
</div>
|
</div>
|
||||||
<div className="flex items-center gap-3">
|
<div className="flex items-center gap-1">
|
||||||
<StatusDot status={status} />
|
<StatusDot status={status} />
|
||||||
<Button
|
<Button
|
||||||
variant="ghost"
|
variant="ghost"
|
||||||
size="icon-sm"
|
size="icon-sm"
|
||||||
onClick={() => setShowConfig(true)}
|
onClick={() => setView({ name: 'history' })}
|
||||||
|
className="cursor-pointer"
|
||||||
|
>
|
||||||
|
<History className="size-3.5" />
|
||||||
|
</Button>
|
||||||
|
<Button
|
||||||
|
variant="ghost"
|
||||||
|
size="icon-sm"
|
||||||
|
onClick={() => setView({ name: 'config' })}
|
||||||
className="cursor-pointer"
|
className="cursor-pointer"
|
||||||
>
|
>
|
||||||
<Settings className="size-3.5" />
|
<Settings className="size-3.5" />
|
||||||
@@ -110,7 +178,6 @@ export default function App() {
|
|||||||
{showEmptyState && <EmptyState />}
|
{showEmptyState && <EmptyState />}
|
||||||
|
|
||||||
{history.map((event, index) => (
|
{history.map((event, index) => (
|
||||||
// eslint-disable-next-line react-x/no-array-index-key
|
|
||||||
<EventCard key={index} event={event} />
|
<EventCard key={index} event={event} />
|
||||||
))}
|
))}
|
||||||
|
|
||||||
|
|||||||
@@ -1,46 +0,0 @@
|
|||||||
import type { AgentStatus } from '@page-agent/core'
|
|
||||||
|
|
||||||
import { cn } from '@/lib/utils'
|
|
||||||
|
|
||||||
// Status dot indicator
|
|
||||||
export function StatusDot({ status }: { status: AgentStatus }) {
|
|
||||||
const colorClass = {
|
|
||||||
idle: 'bg-muted-foreground',
|
|
||||||
running: 'bg-blue-500',
|
|
||||||
completed: 'bg-green-500',
|
|
||||||
error: 'bg-destructive',
|
|
||||||
}[status]
|
|
||||||
|
|
||||||
const label = {
|
|
||||||
idle: 'Ready',
|
|
||||||
running: 'Running',
|
|
||||||
completed: 'Done',
|
|
||||||
error: 'Error',
|
|
||||||
}[status]
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className="flex items-center gap-1.5">
|
|
||||||
<span
|
|
||||||
className={cn('size-2 rounded-full', colorClass, status === 'running' && 'animate-pulse')}
|
|
||||||
/>
|
|
||||||
<span className="text-xs text-muted-foreground">{label}</span>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
export function Logo({ className }: { className?: string }) {
|
|
||||||
return <img src="/assets/page-agent-256.webp" alt="Page Agent" className={cn('', className)} />
|
|
||||||
}
|
|
||||||
|
|
||||||
// Empty state with logo
|
|
||||||
export function EmptyState() {
|
|
||||||
return (
|
|
||||||
<div className="flex flex-col items-center justify-center h-full gap-3 text-center px-6">
|
|
||||||
<Logo className="size-20 opacity-80" />
|
|
||||||
<div>
|
|
||||||
<h2 className="text-sm font-medium text-foreground">Page Agent Ext</h2>
|
|
||||||
<p className="text-xs text-muted-foreground mt-1">Enter a task to automate this page</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
@@ -1,8 +1,9 @@
|
|||||||
import React from 'react'
|
import React from 'react'
|
||||||
import ReactDOM from 'react-dom/client'
|
import ReactDOM from 'react-dom/client'
|
||||||
|
|
||||||
|
import { ErrorBoundary } from '@/components/ErrorBoundary'
|
||||||
|
|
||||||
import App from './App'
|
import App from './App'
|
||||||
import { ErrorBoundary } from './components/ErrorBoundary'
|
|
||||||
|
|
||||||
import '@/assets/index.css'
|
import '@/assets/index.css'
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,70 @@
|
|||||||
|
import type { HistoricalEvent } from '@page-agent/core'
|
||||||
|
import { type DBSchema, type IDBPDatabase, openDB } from 'idb'
|
||||||
|
|
||||||
|
const DB_NAME = 'page-agent-ext'
|
||||||
|
const DB_VERSION = 1
|
||||||
|
|
||||||
|
export interface SessionRecord {
|
||||||
|
id: string
|
||||||
|
task: string
|
||||||
|
history: HistoricalEvent[]
|
||||||
|
status: 'completed' | 'error'
|
||||||
|
createdAt: number
|
||||||
|
}
|
||||||
|
|
||||||
|
interface PageAgentDB extends DBSchema {
|
||||||
|
sessions: {
|
||||||
|
key: string
|
||||||
|
value: SessionRecord
|
||||||
|
indexes: { 'by-created': number }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let dbPromise: Promise<IDBPDatabase<PageAgentDB>> | null = null
|
||||||
|
|
||||||
|
function getDB() {
|
||||||
|
if (!dbPromise) {
|
||||||
|
dbPromise = openDB<PageAgentDB>(DB_NAME, DB_VERSION, {
|
||||||
|
upgrade(db) {
|
||||||
|
const store = db.createObjectStore('sessions', { keyPath: 'id' })
|
||||||
|
store.createIndex('by-created', 'createdAt')
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return dbPromise
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function saveSession(
|
||||||
|
session: Omit<SessionRecord, 'id' | 'createdAt'>
|
||||||
|
): Promise<SessionRecord> {
|
||||||
|
const db = await getDB()
|
||||||
|
const record: SessionRecord = {
|
||||||
|
...session,
|
||||||
|
id: crypto.randomUUID(),
|
||||||
|
createdAt: Date.now(),
|
||||||
|
}
|
||||||
|
await db.put('sessions', record)
|
||||||
|
return record
|
||||||
|
}
|
||||||
|
|
||||||
|
/** List sessions, newest first */
|
||||||
|
export async function listSessions(): Promise<SessionRecord[]> {
|
||||||
|
const db = await getDB()
|
||||||
|
const all = await db.getAllFromIndex('sessions', 'by-created')
|
||||||
|
return all.reverse()
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getSession(id: string): Promise<SessionRecord | undefined> {
|
||||||
|
const db = await getDB()
|
||||||
|
return db.get('sessions', id)
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function deleteSession(id: string): Promise<void> {
|
||||||
|
const db = await getDB()
|
||||||
|
await db.delete('sessions', id)
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function clearSessions(): Promise<void> {
|
||||||
|
const db = await getDB()
|
||||||
|
await db.clear('sessions')
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
import type { HistoricalEvent } from '@page-agent/core'
|
||||||
|
|
||||||
|
const EXPORT_FILE_PREFIX = 'page-agent-history'
|
||||||
|
const MAX_TASK_SLUG_LENGTH = 40
|
||||||
|
|
||||||
|
export function serializeHistoryExport(history: HistoricalEvent[]): string {
|
||||||
|
return `${JSON.stringify(history, null, 2)}\n`
|
||||||
|
}
|
||||||
|
|
||||||
|
export function buildHistoryExportFilename(task: string, createdAt: number): string {
|
||||||
|
const taskSlug = sanitizeTaskForFilename(task)
|
||||||
|
const timestamp = formatTimestampForFilename(createdAt)
|
||||||
|
|
||||||
|
return taskSlug
|
||||||
|
? `${EXPORT_FILE_PREFIX}-${taskSlug}-${timestamp}.json`
|
||||||
|
: `${EXPORT_FILE_PREFIX}-${timestamp}.json`
|
||||||
|
}
|
||||||
|
|
||||||
|
export function downloadHistoryExport(
|
||||||
|
task: string,
|
||||||
|
createdAt: number,
|
||||||
|
history: HistoricalEvent[]
|
||||||
|
): void {
|
||||||
|
const filename = buildHistoryExportFilename(task, createdAt)
|
||||||
|
const content = serializeHistoryExport(history)
|
||||||
|
const blob = new Blob([content], { type: 'application/json;charset=utf-8' })
|
||||||
|
const url = URL.createObjectURL(blob)
|
||||||
|
const link = document.createElement('a')
|
||||||
|
|
||||||
|
link.href = url
|
||||||
|
link.download = filename
|
||||||
|
link.click()
|
||||||
|
|
||||||
|
URL.revokeObjectURL(url)
|
||||||
|
}
|
||||||
|
|
||||||
|
function sanitizeTaskForFilename(task: string): string {
|
||||||
|
return task
|
||||||
|
.trim()
|
||||||
|
.toLowerCase()
|
||||||
|
.replace(/[^a-z0-9]+/g, '-')
|
||||||
|
.replace(/^-+|-+$/g, '')
|
||||||
|
.slice(0, MAX_TASK_SLUG_LENGTH)
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatTimestampForFilename(createdAt: number): string {
|
||||||
|
const date = new Date(createdAt)
|
||||||
|
const year = date.getFullYear()
|
||||||
|
const month = pad(date.getMonth() + 1)
|
||||||
|
const day = pad(date.getDate())
|
||||||
|
const hours = pad(date.getHours())
|
||||||
|
const minutes = pad(date.getMinutes())
|
||||||
|
const seconds = pad(date.getSeconds())
|
||||||
|
|
||||||
|
return `${year}-${month}-${day}_${hours}-${minutes}-${seconds}`
|
||||||
|
}
|
||||||
|
|
||||||
|
function pad(value: number): string {
|
||||||
|
return value.toString().padStart(2, '0')
|
||||||
|
}
|
||||||
+1
-2
@@ -1,2 +1 @@
|
|||||||
declare const __EXT_VERSION__: string
|
declare const __VERSION__: string
|
||||||
declare const __CORE_VERSION__: string
|
|
||||||
|
|||||||
@@ -3,26 +3,11 @@
|
|||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.tsbuildinfo",
|
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.tsbuildinfo",
|
||||||
"useDefineForClassFields": true,
|
"useDefineForClassFields": true,
|
||||||
"noEmit": false,
|
|
||||||
"allowImportingTsExtensions": false,
|
|
||||||
"strictNullChecks": true,
|
"strictNullChecks": true,
|
||||||
"jsx": "react-jsx",
|
"jsx": "react-jsx",
|
||||||
"baseUrl": ".",
|
"types": ["node", "chrome"],
|
||||||
"paths": {
|
"paths": {
|
||||||
// Self root
|
"@/*": ["./src/*"]
|
||||||
"@/*": ["src/*"],
|
|
||||||
|
|
||||||
"@page-agent/llms": ["../llms/src/index.ts"],
|
|
||||||
"@page-agent/page-controller": ["../page-controller/src/PageController.ts"],
|
|
||||||
"@page-agent/core": ["../core/src/PageAgentCore.ts"],
|
|
||||||
"@page-agent/ui": ["../ui/src/index.ts"]
|
|
||||||
}
|
}
|
||||||
},
|
}
|
||||||
"references": [
|
|
||||||
//
|
|
||||||
{ "path": "../llms" },
|
|
||||||
{ "path": "../page-controller" },
|
|
||||||
{ "path": "../core" },
|
|
||||||
{ "path": "../ui" }
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -19,8 +19,7 @@ export default defineConfig({
|
|||||||
vite: () => ({
|
vite: () => ({
|
||||||
plugins: [tailwindcss()],
|
plugins: [tailwindcss()],
|
||||||
define: {
|
define: {
|
||||||
__EXT_VERSION__: JSON.stringify(pkg.version),
|
__VERSION__: JSON.stringify(pkg.version),
|
||||||
__CORE_VERSION__: JSON.stringify(pkg.dependencies['@page-agent/core']),
|
|
||||||
},
|
},
|
||||||
optimizeDeps: {
|
optimizeDeps: {
|
||||||
force: true,
|
force: true,
|
||||||
@@ -37,10 +36,14 @@ export default defineConfig({
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
|
zip: {
|
||||||
|
artifactTemplate: 'page-agent-ext-{{version}}-{{browser}}.zip',
|
||||||
|
},
|
||||||
manifest: {
|
manifest: {
|
||||||
name: 'Page Agent Ext',
|
key: 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqbzT0iTYeYlnCvDJIGDnGU8oarJgZILDzSfLi/ufuSxXEPDKuMyD892GhvrMCZNVHS11Sh6NYUOc/PcUOhtaR2urHtcNkrpSJNV10zUamY7fxBdVEkOucfyLu8INVy+teis62MoRWYPaUPkfZUjrLGW8MsZ9aFzARfu9GGDEp2EAYsWDN6w6vyz9LJ82pm542EWnVT4MjmDPgvYFCWGBtaU/dfHD+GAX6URJFapsCvryVURKJ+76c/GO9/I3EX1IBfbY6dec78bLCMvVxiTmiv36KyGPwX1OpakW8IiCpXWdbAxjm+plbYlp5t5zTyyoE3sOSFeXsBH0Kg27o8GcvQIDAQAB',
|
||||||
description:
|
default_locale: 'en',
|
||||||
'AI-powered browser automation assistant. Control web pages with natural language.',
|
name: '__MSG_extName__',
|
||||||
|
description: '__MSG_extDescription__',
|
||||||
homepage_url: 'https://alibaba.github.io/page-agent/',
|
homepage_url: 'https://alibaba.github.io/page-agent/',
|
||||||
permissions: ['tabs', 'tabGroups', 'sidePanel', 'storage'],
|
permissions: ['tabs', 'tabGroups', 'sidePanel', 'storage'],
|
||||||
host_permissions: ['<all_urls>'],
|
host_permissions: ['<all_urls>'],
|
||||||
@@ -48,7 +51,7 @@ export default defineConfig({
|
|||||||
64: 'assets/page-agent-64.png',
|
64: 'assets/page-agent-64.png',
|
||||||
},
|
},
|
||||||
action: {
|
action: {
|
||||||
default_title: 'Open Page Agent',
|
default_title: '__MSG_extActionTitle__',
|
||||||
},
|
},
|
||||||
web_accessible_resources: [
|
web_accessible_resources: [
|
||||||
{
|
{
|
||||||
@@ -59,5 +62,8 @@ export default defineConfig({
|
|||||||
side_panel: {
|
side_panel: {
|
||||||
default_path: 'sidepanel/index.html',
|
default_path: 'sidepanel/index.html',
|
||||||
},
|
},
|
||||||
|
externally_connectable: {
|
||||||
|
matches: ['http://localhost/*'],
|
||||||
|
},
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|||||||
+26
-11
@@ -1,15 +1,25 @@
|
|||||||
{
|
{
|
||||||
"name": "@page-agent/llms",
|
"name": "@page-agent/llms",
|
||||||
"version": "1.1.0",
|
"version": "1.8.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./dist/lib/page-agent-llms.js",
|
"main": "./src/index.ts",
|
||||||
"module": "./dist/lib/page-agent-llms.js",
|
"types": "./src/index.ts",
|
||||||
"types": "./dist/lib/index.d.ts",
|
|
||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"types": "./dist/lib/index.d.ts",
|
"types": "./src/index.ts",
|
||||||
"import": "./dist/lib/page-agent-llms.js",
|
"default": "./src/index.ts"
|
||||||
"default": "./dist/lib/page-agent-llms.js"
|
}
|
||||||
|
},
|
||||||
|
"publishConfig": {
|
||||||
|
"main": "./dist/lib/page-agent-llms.js",
|
||||||
|
"module": "./dist/lib/page-agent-llms.js",
|
||||||
|
"types": "./dist/lib/index.d.ts",
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"types": "./dist/lib/index.d.ts",
|
||||||
|
"import": "./dist/lib/page-agent-llms.js",
|
||||||
|
"default": "./dist/lib/page-agent-llms.js"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
@@ -33,11 +43,16 @@
|
|||||||
"homepage": "https://alibaba.github.io/page-agent/",
|
"homepage": "https://alibaba.github.io/page-agent/",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "vite build",
|
"build": "vite build",
|
||||||
"prepublishOnly": "node -e \"const fs=require('fs');['LICENSE'].forEach(f=>fs.copyFileSync('../../'+f,f))\"",
|
"prepublishOnly": "node ../../scripts/pre-publish.js",
|
||||||
"postpublish": "node -e \"['LICENSE'].forEach(f=>{try{require('fs').unlinkSync(f)}catch{}})\""
|
"postpublish": "node ../../scripts/post-publish.js"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"chalk": "^5.6.2",
|
"chalk": "^5.6.2"
|
||||||
"zod": "^4.3.5"
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"zod": "^3.25.0 || ^4.0.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"zod": "^4.3.6"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
/**
|
/**
|
||||||
* OpenAI Client implementation
|
* OpenAI Client implementation
|
||||||
*/
|
*/
|
||||||
|
import * as z from 'zod/v4'
|
||||||
|
|
||||||
import { InvokeError, InvokeErrorType } from './errors'
|
import { InvokeError, InvokeErrorType } from './errors'
|
||||||
import type { InvokeOptions, InvokeResult, LLMClient, LLMConfig, Message, Tool } from './types'
|
import type { InvokeOptions, InvokeResult, LLMClient, LLMConfig, Message, Tool } from './types'
|
||||||
import { modelPatch, zodToOpenAITool } from './utils'
|
import { modelPatch, zodToOpenAITool } from './utils'
|
||||||
@@ -27,16 +29,19 @@ export class OpenAIClient implements LLMClient {
|
|||||||
const openaiTools = Object.entries(tools).map(([name, t]) => zodToOpenAITool(name, t))
|
const openaiTools = Object.entries(tools).map(([name, t]) => zodToOpenAITool(name, t))
|
||||||
|
|
||||||
// Build request body
|
// Build request body
|
||||||
|
|
||||||
|
let toolChoice: unknown = 'required'
|
||||||
|
if (options?.toolChoiceName && !this.config.disableNamedToolChoice) {
|
||||||
|
toolChoice = { type: 'function', function: { name: options.toolChoiceName } }
|
||||||
|
}
|
||||||
|
|
||||||
const requestBody: Record<string, unknown> = {
|
const requestBody: Record<string, unknown> = {
|
||||||
model: this.config.model,
|
model: this.config.model,
|
||||||
temperature: this.config.temperature,
|
temperature: this.config.temperature,
|
||||||
messages,
|
messages,
|
||||||
tools: openaiTools,
|
tools: openaiTools,
|
||||||
parallel_tool_calls: false,
|
parallel_tool_calls: false,
|
||||||
// Require tool call: specific tool if provided, otherwise any tool
|
tool_choice: toolChoice,
|
||||||
tool_choice: options?.toolChoiceName
|
|
||||||
? { type: 'function', function: { name: options.toolChoiceName } }
|
|
||||||
: 'required',
|
|
||||||
}
|
}
|
||||||
|
|
||||||
modelPatch(requestBody)
|
modelPatch(requestBody)
|
||||||
@@ -48,14 +53,16 @@ export class OpenAIClient implements LLMClient {
|
|||||||
method: 'POST',
|
method: 'POST',
|
||||||
headers: {
|
headers: {
|
||||||
'Content-Type': 'application/json',
|
'Content-Type': 'application/json',
|
||||||
Authorization: `Bearer ${this.config.apiKey}`,
|
...(this.config.apiKey && { Authorization: `Bearer ${this.config.apiKey}` }),
|
||||||
},
|
},
|
||||||
body: JSON.stringify(requestBody),
|
body: JSON.stringify(requestBody),
|
||||||
signal: abortSignal,
|
signal: abortSignal,
|
||||||
})
|
})
|
||||||
} catch (error: unknown) {
|
} catch (error: unknown) {
|
||||||
console.error(error)
|
const isAbortError = (error as any)?.name === 'AbortError'
|
||||||
throw new InvokeError(InvokeErrorType.NETWORK_ERROR, 'Network request failed', error)
|
const errorMessage = isAbortError ? 'Network request aborted' : 'Network request failed'
|
||||||
|
if (!isAbortError) console.error(error)
|
||||||
|
throw new InvokeError(InvokeErrorType.NETWORK_ERROR, errorMessage, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
// 3. Handle HTTP errors
|
// 3. Handle HTTP errors
|
||||||
@@ -180,7 +187,7 @@ export class OpenAIClient implements LLMClient {
|
|||||||
// Validate with schema
|
// Validate with schema
|
||||||
const validation = tool.inputSchema.safeParse(parsedArgs)
|
const validation = tool.inputSchema.safeParse(parsedArgs)
|
||||||
if (!validation.success) {
|
if (!validation.success) {
|
||||||
console.error(validation.error)
|
console.error(z.prettifyError(validation.error))
|
||||||
throw new InvokeError(
|
throw new InvokeError(
|
||||||
InvokeErrorType.INVALID_TOOL_ARGS,
|
InvokeErrorType.INVALID_TOOL_ARGS,
|
||||||
'Tool arguments validation failed',
|
'Tool arguments validation failed',
|
||||||
|
|||||||
Vendored
-1
@@ -1 +0,0 @@
|
|||||||
/// <reference types="vite/client" />
|
|
||||||
@@ -34,12 +34,15 @@ export class InvokeError extends Error {
|
|||||||
super(message)
|
super(message)
|
||||||
this.name = 'InvokeError'
|
this.name = 'InvokeError'
|
||||||
this.type = type
|
this.type = type
|
||||||
this.retryable = this.isRetryable(type)
|
this.retryable = this.isRetryable(type, rawError)
|
||||||
this.rawError = rawError
|
this.rawError = rawError
|
||||||
this.rawResponse = rawResponse
|
this.rawResponse = rawResponse
|
||||||
}
|
}
|
||||||
|
|
||||||
private isRetryable(type: InvokeErrorType): boolean {
|
private isRetryable(type: InvokeErrorType, rawError?: unknown): boolean {
|
||||||
|
const isAbortError = (rawError as any)?.name === 'AbortError'
|
||||||
|
if (isAbortError) return false
|
||||||
|
|
||||||
const retryableTypes: InvokeErrorType[] = [
|
const retryableTypes: InvokeErrorType[] = [
|
||||||
InvokeErrorType.NETWORK_ERROR,
|
InvokeErrorType.NETWORK_ERROR,
|
||||||
InvokeErrorType.RATE_LIMIT,
|
InvokeErrorType.RATE_LIMIT,
|
||||||
|
|||||||
@@ -1,25 +1,27 @@
|
|||||||
import { OpenAIClient } from './OpenAIClient'
|
import { OpenAIClient } from './OpenAIClient'
|
||||||
import { DEFAULT_TEMPERATURE, LLM_MAX_RETRIES } from './constants'
|
import { DEFAULT_TEMPERATURE, LLM_MAX_RETRIES } from './constants'
|
||||||
import { InvokeError } from './errors'
|
import { InvokeError, InvokeErrorType } from './errors'
|
||||||
import type { InvokeOptions, InvokeResult, LLMClient, LLMConfig, Message, Tool } from './types'
|
import type { InvokeOptions, InvokeResult, LLMClient, LLMConfig, Message, Tool } from './types'
|
||||||
|
|
||||||
export type { InvokeError, InvokeOptions, InvokeResult, LLMClient, LLMConfig, Message, Tool }
|
export { InvokeError, InvokeErrorType }
|
||||||
|
export type { InvokeOptions, InvokeResult, LLMClient, LLMConfig, Message, Tool }
|
||||||
|
|
||||||
export function parseLLMConfig(config: LLMConfig): Required<LLMConfig> {
|
export function parseLLMConfig(config: LLMConfig): Required<LLMConfig> {
|
||||||
// Runtime validation as defensive programming (types already guarantee these)
|
// Runtime validation as defensive programming (types already guarantee these)
|
||||||
if (!config.baseURL || !config.apiKey || !config.model) {
|
if (!config.baseURL || !config.model) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
'[PageAgent] LLM configuration required. Please provide: baseURL, apiKey, model. ' +
|
'[PageAgent] LLM configuration required. Please provide: baseURL, model. ' +
|
||||||
'See: https://alibaba.github.io/page-agent/#/docs/features/models'
|
'See: https://alibaba.github.io/page-agent/docs/features/models'
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
baseURL: config.baseURL,
|
baseURL: config.baseURL,
|
||||||
apiKey: config.apiKey,
|
|
||||||
model: config.model,
|
model: config.model,
|
||||||
|
apiKey: config.apiKey || '',
|
||||||
temperature: config.temperature ?? DEFAULT_TEMPERATURE,
|
temperature: config.temperature ?? DEFAULT_TEMPERATURE,
|
||||||
maxRetries: config.maxRetries ?? LLM_MAX_RETRIES,
|
maxRetries: config.maxRetries ?? LLM_MAX_RETRIES,
|
||||||
|
disableNamedToolChoice: config.disableNamedToolChoice ?? false,
|
||||||
customFetch: (config.customFetch ?? fetch).bind(globalThis), // fetch will be illegal unless bound
|
customFetch: (config.customFetch ?? fetch).bind(globalThis), // fetch will be illegal unless bound
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -49,6 +51,9 @@ export class LLM extends EventTarget {
|
|||||||
): Promise<InvokeResult> {
|
): Promise<InvokeResult> {
|
||||||
return await withRetry(
|
return await withRetry(
|
||||||
async () => {
|
async () => {
|
||||||
|
// in case user aborted before invoking
|
||||||
|
if (abortSignal.aborted) throw new Error('AbortError')
|
||||||
|
|
||||||
const result = await this.client.invoke(messages, tools, abortSignal, options)
|
const result = await this.client.invoke(messages, tools, abortSignal, options)
|
||||||
|
|
||||||
return result
|
return result
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* Core types for LLM integration
|
* Core types for LLM integration
|
||||||
*/
|
*/
|
||||||
import type { z } from 'zod'
|
import type * as z from 'zod/v4'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Message format - OpenAI standard (industry standard)
|
* Message format - OpenAI standard (industry standard)
|
||||||
@@ -89,12 +89,18 @@ export interface InvokeResult<TResult = unknown> {
|
|||||||
*/
|
*/
|
||||||
export interface LLMConfig {
|
export interface LLMConfig {
|
||||||
baseURL: string
|
baseURL: string
|
||||||
apiKey: string
|
|
||||||
model: string
|
model: string
|
||||||
|
apiKey?: string
|
||||||
|
|
||||||
temperature?: number
|
temperature?: number
|
||||||
maxRetries?: number
|
maxRetries?: number
|
||||||
|
|
||||||
|
/**
|
||||||
|
* remove the tool_choice field from the request.
|
||||||
|
* @note fix "Invalid tool_choice type: 'object'" for some LLMs.
|
||||||
|
*/
|
||||||
|
disableNamedToolChoice?: boolean
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Custom fetch function for LLM API requests.
|
* Custom fetch function for LLM API requests.
|
||||||
* Use this to customize headers, credentials, proxy, etc.
|
* Use this to customize headers, credentials, proxy, etc.
|
||||||
|
|||||||
@@ -2,13 +2,11 @@
|
|||||||
* Utility functions for LLM integration
|
* Utility functions for LLM integration
|
||||||
*/
|
*/
|
||||||
import chalk from 'chalk'
|
import chalk from 'chalk'
|
||||||
import { z } from 'zod'
|
import * as z from 'zod/v4'
|
||||||
|
|
||||||
import type { Tool } from './types'
|
import type { Tool } from './types'
|
||||||
|
|
||||||
function debug(message: string) {
|
const debug = console.debug.bind(console, chalk.gray('[LLM]'))
|
||||||
console.debug(chalk.gray('[LLM]'), message)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convert Zod schema to OpenAI tool format
|
* Convert Zod schema to OpenAI tool format
|
||||||
@@ -38,6 +36,7 @@ export function modelPatch(body: Record<string, any>) {
|
|||||||
if (modelName.startsWith('qwen')) {
|
if (modelName.startsWith('qwen')) {
|
||||||
debug('Applying Qwen patch: use higher temperature for auto fixing')
|
debug('Applying Qwen patch: use higher temperature for auto fixing')
|
||||||
body.temperature = Math.max(body.temperature || 0, 1.0)
|
body.temperature = Math.max(body.temperature || 0, 1.0)
|
||||||
|
body.enable_thinking = false
|
||||||
}
|
}
|
||||||
|
|
||||||
if (modelName.startsWith('claude')) {
|
if (modelName.startsWith('claude')) {
|
||||||
@@ -74,6 +73,15 @@ export function modelPatch(body: Record<string, any>) {
|
|||||||
} else if (modelName.startsWith('gpt-51')) {
|
} else if (modelName.startsWith('gpt-51')) {
|
||||||
debug('Applying GPT-51 patch: disable reasoning')
|
debug('Applying GPT-51 patch: disable reasoning')
|
||||||
body.reasoning_effort = 'none'
|
body.reasoning_effort = 'none'
|
||||||
|
} else if (modelName.startsWith('gpt-54')) {
|
||||||
|
debug(
|
||||||
|
'Applying GPT-5.4 patch: skip reasoning_effort because chat/completions rejects it with function tools'
|
||||||
|
)
|
||||||
|
delete body.reasoning_effort
|
||||||
|
} else if (modelName.startsWith('gpt-5-mini')) {
|
||||||
|
debug('Applying GPT-5-mini patch: set reasoning effort to low, temperature to 1')
|
||||||
|
body.reasoning_effort = 'low'
|
||||||
|
body.temperature = 1
|
||||||
} else if (modelName.startsWith('gpt-5')) {
|
} else if (modelName.startsWith('gpt-5')) {
|
||||||
debug('Applying GPT-5 patch: set reasoning effort to low')
|
debug('Applying GPT-5 patch: set reasoning effort to low')
|
||||||
body.reasoning_effort = 'low'
|
body.reasoning_effort = 'low'
|
||||||
@@ -85,6 +93,15 @@ export function modelPatch(body: Record<string, any>) {
|
|||||||
body.reasoning_effort = 'minimal'
|
body.reasoning_effort = 'minimal'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (modelName.startsWith('minimax')) {
|
||||||
|
debug('Applying MiniMax patch: clamp temperature to (0, 1]')
|
||||||
|
// MiniMax API rejects temperature = 0; clamp to a small positive value
|
||||||
|
body.temperature = Math.max(body.temperature || 0, 0.01)
|
||||||
|
if (body.temperature > 1) body.temperature = 1
|
||||||
|
// MiniMax does not support parallel_tool_calls
|
||||||
|
delete body.parallel_tool_calls
|
||||||
|
}
|
||||||
|
|
||||||
return body
|
return body
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "./tsconfig.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
// @workaround DTS bug
|
|
||||||
// dts do not work with monorepo path mapping
|
|
||||||
// disable path mapping for it
|
|
||||||
"paths": {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,11 +1,7 @@
|
|||||||
{
|
{
|
||||||
"extends": "../../tsconfig.base.json",
|
"extends": "../../tsconfig.base.json",
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.tsbuildinfo",
|
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.tsbuildinfo"
|
||||||
"noEmit": false,
|
|
||||||
"allowImportingTsExtensions": false,
|
|
||||||
"baseUrl": ".",
|
|
||||||
"outDir": "dist"
|
|
||||||
},
|
},
|
||||||
"include": ["**/*.ts"],
|
"include": ["**/*.ts"],
|
||||||
"exclude": ["dist", "node_modules"]
|
"exclude": ["dist", "node_modules"]
|
||||||
|
|||||||
@@ -11,11 +11,18 @@ console.log(chalk.cyan(`📦 Building @page-agent/llms`))
|
|||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
clearScreen: false,
|
clearScreen: false,
|
||||||
plugins: [dts({ tsconfigPath: './tsconfig.dts.json', bundleTypes: true })],
|
plugins: [
|
||||||
|
dts({
|
||||||
|
bundleTypes: true,
|
||||||
|
compilerOptions: {
|
||||||
|
composite: true,
|
||||||
|
noEmit: false,
|
||||||
|
emitDeclarationOnly: true,
|
||||||
|
declaration: true,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
],
|
||||||
publicDir: false,
|
publicDir: false,
|
||||||
esbuild: {
|
|
||||||
keepNames: true,
|
|
||||||
},
|
|
||||||
build: {
|
build: {
|
||||||
lib: {
|
lib: {
|
||||||
entry: resolve(__dirname, 'src/index.ts'),
|
entry: resolve(__dirname, 'src/index.ts'),
|
||||||
@@ -25,7 +32,7 @@ export default defineConfig({
|
|||||||
},
|
},
|
||||||
outDir: resolve(__dirname, 'dist', 'lib'),
|
outDir: resolve(__dirname, 'dist', 'lib'),
|
||||||
rollupOptions: {
|
rollupOptions: {
|
||||||
external: ['chalk', 'zod'],
|
external: ['chalk', 'zod', 'zod/v4'],
|
||||||
},
|
},
|
||||||
minify: false,
|
minify: false,
|
||||||
sourcemap: true,
|
sourcemap: true,
|
||||||
|
|||||||
@@ -0,0 +1,94 @@
|
|||||||
|
# @page-agent/mcp
|
||||||
|
|
||||||
|
MCP server that lets AI agent clients (Claude Desktop, Copilot, etc.) control your browser through the [Page Agent](https://github.com/alibaba/page-agent) extension.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- Node.js >= 20
|
||||||
|
- [Page Agent Extension](https://chromewebstore.google.com/detail/page-agent-ext/akldabonmimlicnjlflnapfeklbfemhj) installed in Chrome
|
||||||
|
- An LLM API key (OpenAI-compatible)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Claude Desktop
|
||||||
|
|
||||||
|
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"page-agent": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["-y", "@page-agent/mcp"],
|
||||||
|
"env": {
|
||||||
|
"LLM_BASE_URL": "https://dashscope.aliyuncs.com/compatible-mode/v1",
|
||||||
|
"LLM_API_KEY": "sk-xxx",
|
||||||
|
"LLM_MODEL_NAME": "qwen3.5-plus"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Cursor / Copilot
|
||||||
|
|
||||||
|
Same format — add the config to the MCP settings of your client.
|
||||||
|
|
||||||
|
## MCP Tools
|
||||||
|
|
||||||
|
| Tool | Input | Description |
|
||||||
|
| -------------- | ------------------ | ---------------------------------------------------- |
|
||||||
|
| `execute_task` | `{ task: string }` | Execute a browser task in natural language. Blocking. |
|
||||||
|
| `get_status` | — | Returns `{ connected, busy }` |
|
||||||
|
| `stop_task` | — | Stop the currently running task. |
|
||||||
|
|
||||||
|
## Environment Variables
|
||||||
|
|
||||||
|
| Variable | Default | Description |
|
||||||
|
| ---------------- | ------- | --------------------- |
|
||||||
|
| `LLM_BASE_URL` | — | LLM API base URL |
|
||||||
|
| `LLM_API_KEY` | — | LLM API key |
|
||||||
|
| `LLM_MODEL_NAME` | — | Model name |
|
||||||
|
| `PORT` | `38401` | HTTP + WebSocket port |
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
```
|
||||||
|
┌──────────────┐ stdio ┌──────────────────┐ WebSocket ┌──────────────┐
|
||||||
|
│ Claude / │◄────────►│ @page-agent/mcp │◄────────────►│ Hub tab │
|
||||||
|
│ Copilot │ (MCP) │ (Node.js) │ (localhost) │ (extension) │
|
||||||
|
└──────────────┘ └──────────────────┘ └──────┬───────┘
|
||||||
|
│ │
|
||||||
|
│ HTTP │ useAgent
|
||||||
|
▼ ▼
|
||||||
|
┌──────────────────┐ ┌──────────────┐
|
||||||
|
│ Launcher page │ │ MultiPage │
|
||||||
|
│ (localhost:PORT) │ │ Agent │
|
||||||
|
└──────────────────┘ └──────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Agent client starts the MCP server via stdio (`npx @page-agent/mcp`).
|
||||||
|
2. Server starts HTTP + WS on `localhost:PORT`, opens the launcher page in browser.
|
||||||
|
3. Launcher page triggers the extension to open a **hub tab** (`hub.html?ws=PORT`).
|
||||||
|
4. Hub connects to the WS server. MCP tools now proxy tasks to the hub.
|
||||||
|
|
||||||
|
The hub tab speaks a generic WebSocket protocol (defined in `hub-ws.ts` in the extension package) and has no knowledge of MCP. See the hub's protocol docs for message format details.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
Pure JS ESM, no build step. Source files are the published artifacts.
|
||||||
|
|
||||||
|
```
|
||||||
|
src/
|
||||||
|
├── index.js # CLI entry: MCP server (stdio) + opens launcher
|
||||||
|
├── hub-bridge.js # HTTP server + WebSocket bridge to hub tab
|
||||||
|
└── launcher.html # Bootstrap page: detects extension, triggers hub open
|
||||||
|
```
|
||||||
|
|
||||||
|
## Dev
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run build:libs
|
||||||
|
npm run dev:ext
|
||||||
|
npx @modelcontextprotocol/inspector node packages/mcp/src/index.js
|
||||||
|
```
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
{
|
||||||
|
"name": "@page-agent/mcp",
|
||||||
|
"private": false,
|
||||||
|
"version": "1.8.0",
|
||||||
|
"type": "module",
|
||||||
|
"bin": {
|
||||||
|
"page-agent-mcp": "src/index.js"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"src/"
|
||||||
|
],
|
||||||
|
"description": "MCP server for controlling the browser via Page Agent extension",
|
||||||
|
"keywords": [
|
||||||
|
"page-agent",
|
||||||
|
"mcp",
|
||||||
|
"browser-automation",
|
||||||
|
"chrome-extension"
|
||||||
|
],
|
||||||
|
"author": "Simon<gaomeng1900>",
|
||||||
|
"license": "MIT",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/alibaba/page-agent.git",
|
||||||
|
"directory": "packages/mcp"
|
||||||
|
},
|
||||||
|
"homepage": "https://alibaba.github.io/page-agent/",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=20"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@modelcontextprotocol/sdk": "^1.29.0",
|
||||||
|
"ws": "^8.20.0",
|
||||||
|
"zod": "^4.3.6"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
import { readFileSync } from 'node:fs'
|
||||||
|
import http from 'node:http'
|
||||||
|
import { fileURLToPath } from 'node:url'
|
||||||
|
import { WebSocketServer } from 'ws'
|
||||||
|
|
||||||
|
const EXT_ID = 'akldabonmimlicnjlflnapfeklbfemhj'
|
||||||
|
const STORE_URL = `https://chromewebstore.google.com/detail/page-agent-ext/${EXT_ID}`
|
||||||
|
const LOOPBACK_HOST = 'localhost'
|
||||||
|
|
||||||
|
const launcherTemplate = readFileSync(
|
||||||
|
fileURLToPath(new URL('./launcher.html', import.meta.url)),
|
||||||
|
'utf-8'
|
||||||
|
)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* HTTP + WebSocket bridge to the hub.html extension tab.
|
||||||
|
* - HTTP serves the launcher page (triggers extension to open hub)
|
||||||
|
* - WS carries execute/stop commands and result/error responses
|
||||||
|
*/
|
||||||
|
export class HubBridge {
|
||||||
|
/** @type {number} */
|
||||||
|
port
|
||||||
|
|
||||||
|
/** @type {http.Server} */
|
||||||
|
#httpServer
|
||||||
|
|
||||||
|
/** @type {WebSocketServer} */
|
||||||
|
#wss
|
||||||
|
|
||||||
|
/** @type {import('ws').WebSocket | null} */
|
||||||
|
#hub = null
|
||||||
|
|
||||||
|
/** @type {{ resolve: (r: {success: boolean, data: string}) => void, reject: (e: Error) => void } | null} */
|
||||||
|
#pendingTask = null
|
||||||
|
|
||||||
|
/** @param {number} port */
|
||||||
|
constructor(port) {
|
||||||
|
this.port = port
|
||||||
|
this.#httpServer = http.createServer((_req, res) => {
|
||||||
|
const html = launcherTemplate
|
||||||
|
.replaceAll('__EXT_ID__', EXT_ID)
|
||||||
|
.replaceAll('__STORE_URL__', STORE_URL)
|
||||||
|
.replaceAll('__WS_PORT__', String(port))
|
||||||
|
res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' })
|
||||||
|
res.end(html)
|
||||||
|
})
|
||||||
|
this.#wss = new WebSocketServer({ server: this.#httpServer })
|
||||||
|
this.#wss.on('connection', (ws) => this.#onConnection(ws))
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @returns {Promise<void>} */
|
||||||
|
async start() {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
this.#httpServer.on('error', (/** @type {NodeJS.ErrnoException} */ err) => {
|
||||||
|
if (err.code === 'EADDRINUSE') {
|
||||||
|
reject(
|
||||||
|
new Error(`Port ${this.port} is in use. Another Page Agent MCP server may be running.`)
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
reject(err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
this.#httpServer.listen(this.port, LOOPBACK_HOST, () => {
|
||||||
|
console.error(`[page-agent-mcp] HTTP + WS on http://${LOOPBACK_HOST}:${this.port}`)
|
||||||
|
resolve()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
get connected() {
|
||||||
|
return this.#hub?.readyState === 1
|
||||||
|
}
|
||||||
|
|
||||||
|
get busy() {
|
||||||
|
return this.#pendingTask !== null
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} task
|
||||||
|
* @param {Record<string, unknown>} [config]
|
||||||
|
* @returns {Promise<{success: boolean, data: string}>}
|
||||||
|
*/
|
||||||
|
async executeTask(task, config) {
|
||||||
|
if (!this.connected) throw new Error('Hub is not connected. Is the extension running?')
|
||||||
|
if (this.#pendingTask) throw new Error('Agent is already running a task.')
|
||||||
|
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
this.#pendingTask = { resolve, reject }
|
||||||
|
this.#hub.send(JSON.stringify({ type: 'execute', task, config }))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
stopTask() {
|
||||||
|
if (this.connected) {
|
||||||
|
this.#hub.send(JSON.stringify({ type: 'stop' }))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: Add version checking
|
||||||
|
|
||||||
|
/** @param {import('ws').WebSocket} ws */
|
||||||
|
#onConnection(ws) {
|
||||||
|
if (this.#hub && this.#hub.readyState === 1) {
|
||||||
|
ws.close(4000, 'Another hub is already connected')
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
this.#hub = ws
|
||||||
|
console.error('[page-agent-mcp] Hub connected')
|
||||||
|
|
||||||
|
ws.on('message', (/** @type {Buffer} */ rawData) => {
|
||||||
|
/** @type {{ type: string, success?: boolean, data?: string, message?: string }} */
|
||||||
|
let msg
|
||||||
|
try {
|
||||||
|
msg = JSON.parse(rawData.toString('utf-8'))
|
||||||
|
} catch {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (msg.type === 'result') {
|
||||||
|
this.#pendingTask?.resolve({ success: msg.success ?? false, data: msg.data ?? '' })
|
||||||
|
this.#pendingTask = null
|
||||||
|
} else if (msg.type === 'error') {
|
||||||
|
this.#pendingTask?.reject(new Error(msg.message ?? 'Unknown error from hub'))
|
||||||
|
this.#pendingTask = null
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
ws.on('close', () => {
|
||||||
|
console.error('[page-agent-mcp] Hub disconnected')
|
||||||
|
if (this.#hub === ws) this.#hub = null
|
||||||
|
if (this.#pendingTask) {
|
||||||
|
this.#pendingTask.reject(new Error('Hub disconnected while task was running'))
|
||||||
|
this.#pendingTask = null
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
Executable
+98
@@ -0,0 +1,98 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
|
||||||
|
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
|
||||||
|
import { exec } from 'node:child_process'
|
||||||
|
import { platform } from 'node:os'
|
||||||
|
import * as z from 'zod/v4'
|
||||||
|
|
||||||
|
import { HubBridge } from './hub-bridge.js'
|
||||||
|
|
||||||
|
const env = process.env
|
||||||
|
const port = parseInt(env.PORT || '38401')
|
||||||
|
|
||||||
|
/** @type {Record<string, string>} */
|
||||||
|
const llmConfig = {}
|
||||||
|
if (env.LLM_BASE_URL) llmConfig.baseURL = env.LLM_BASE_URL
|
||||||
|
if (env.LLM_MODEL_NAME) llmConfig.model = env.LLM_MODEL_NAME
|
||||||
|
if (env.LLM_API_KEY) llmConfig.apiKey = env.LLM_API_KEY
|
||||||
|
|
||||||
|
// --- Hub bridge (HTTP + WebSocket) ---
|
||||||
|
|
||||||
|
const hub = new HubBridge(port)
|
||||||
|
await hub.start()
|
||||||
|
|
||||||
|
// Open launcher in default browser
|
||||||
|
const url = `http://localhost:${port}`
|
||||||
|
const cmd = platform() === 'darwin' ? 'open' : platform() === 'win32' ? 'start ""' : 'xdg-open'
|
||||||
|
exec(`${cmd} "${url}"`, (err) => {
|
||||||
|
if (err) console.error(`[page-agent-mcp] Could not open browser: ${err.message}`)
|
||||||
|
})
|
||||||
|
|
||||||
|
// --- MCP server (stdio) ---
|
||||||
|
|
||||||
|
const mcpServer = new McpServer({ name: 'page-agent', version: '1.5.8' })
|
||||||
|
|
||||||
|
mcpServer.registerTool(
|
||||||
|
'execute_task',
|
||||||
|
{
|
||||||
|
description: "Execute a task in user's browser.",
|
||||||
|
inputSchema: {
|
||||||
|
task: z
|
||||||
|
.string()
|
||||||
|
.describe(
|
||||||
|
'Task description. Give specific instructions for the task. Steps preferable. And the information you want to get after the task is done.'
|
||||||
|
),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
async ({ task }) => {
|
||||||
|
try {
|
||||||
|
const config = Object.keys(llmConfig).length > 0 ? llmConfig : undefined
|
||||||
|
const result = await hub.executeTask(task, config)
|
||||||
|
return {
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: result.success
|
||||||
|
? `Task completed.\n\n${result.data}`
|
||||||
|
: `Task failed.\n\n${result.data}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
return {
|
||||||
|
content: [{ type: 'text', text: `Error: ${err.message}` }],
|
||||||
|
isError: true,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
mcpServer.registerTool(
|
||||||
|
'get_status',
|
||||||
|
{
|
||||||
|
description: 'Check the current status of the Page Agent hub.',
|
||||||
|
},
|
||||||
|
async () => ({
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: 'text',
|
||||||
|
text: JSON.stringify({ connected: hub.connected, busy: hub.busy }, null, 2),
|
||||||
|
},
|
||||||
|
],
|
||||||
|
})
|
||||||
|
)
|
||||||
|
|
||||||
|
mcpServer.registerTool(
|
||||||
|
'stop_task',
|
||||||
|
{
|
||||||
|
description: 'Stop the currently running browser automation task.',
|
||||||
|
},
|
||||||
|
async () => {
|
||||||
|
hub.stopTask()
|
||||||
|
return { content: [{ type: 'text', text: 'Stop signal sent.' }] }
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
const transport = new StdioServerTransport()
|
||||||
|
await mcpServer.connect(transport)
|
||||||
|
console.error('[page-agent-mcp] MCP server ready (stdio)')
|
||||||
@@ -0,0 +1,237 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<link rel="icon" href="https://img.alicdn.com/imgextra/i1/O1CN01mRGret1QrKiu7CFJI_!!6000000002029-2-tps-64-64.png" />
|
||||||
|
<title>Page Agent MCP Launcher</title>
|
||||||
|
<style>
|
||||||
|
* {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
body {
|
||||||
|
font-family:
|
||||||
|
system-ui,
|
||||||
|
-apple-system,
|
||||||
|
sans-serif;
|
||||||
|
background: #09090b;
|
||||||
|
color: #e5e5e5;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
min-height: 100vh;
|
||||||
|
}
|
||||||
|
.card {
|
||||||
|
text-align: center;
|
||||||
|
max-width: 480px;
|
||||||
|
padding: 3rem 2rem;
|
||||||
|
}
|
||||||
|
.logo {
|
||||||
|
width: 72px;
|
||||||
|
height: 72px;
|
||||||
|
border-radius: 18px;
|
||||||
|
margin-bottom: 1rem;
|
||||||
|
}
|
||||||
|
.badge {
|
||||||
|
font-size: 0.6875rem;
|
||||||
|
font-weight: 500;
|
||||||
|
color: #52525b;
|
||||||
|
letter-spacing: 0.05em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
margin-bottom: 1.5rem;
|
||||||
|
}
|
||||||
|
h1 {
|
||||||
|
font-size: 1.35rem;
|
||||||
|
font-weight: 600;
|
||||||
|
margin-bottom: 0.5rem;
|
||||||
|
}
|
||||||
|
.sub {
|
||||||
|
font-size: 0.875rem;
|
||||||
|
color: #a1a1aa;
|
||||||
|
line-height: 1.7;
|
||||||
|
}
|
||||||
|
.spinner {
|
||||||
|
width: 32px;
|
||||||
|
height: 32px;
|
||||||
|
border: 3px solid #27272a;
|
||||||
|
border-top-color: #fff;
|
||||||
|
border-radius: 50%;
|
||||||
|
animation: spin 0.8s linear infinite;
|
||||||
|
margin: 0 auto 1.5rem;
|
||||||
|
}
|
||||||
|
@keyframes spin {
|
||||||
|
to {
|
||||||
|
transform: rotate(360deg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
a {
|
||||||
|
color: #60a5fa;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
a:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.install {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
.install.show {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tips {
|
||||||
|
margin-top: 1.75rem;
|
||||||
|
text-align: left;
|
||||||
|
background: #18181b;
|
||||||
|
border: 1px solid #27272a;
|
||||||
|
border-radius: 12px;
|
||||||
|
padding: 1.25rem 1.5rem;
|
||||||
|
}
|
||||||
|
.tips li {
|
||||||
|
font-size: 0.8125rem;
|
||||||
|
color: #a1a1aa;
|
||||||
|
line-height: 1.7;
|
||||||
|
margin-left: 1rem;
|
||||||
|
}
|
||||||
|
.tips li + li {
|
||||||
|
margin-top: 0.35rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.store-btn {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.625rem;
|
||||||
|
margin-top: 1.5rem;
|
||||||
|
padding: 0.625rem 1.5rem;
|
||||||
|
background: #2563eb;
|
||||||
|
color: #fff;
|
||||||
|
border-radius: 10px;
|
||||||
|
font-size: 0.875rem;
|
||||||
|
font-weight: 500;
|
||||||
|
transition: background 0.15s;
|
||||||
|
}
|
||||||
|
.store-btn:hover {
|
||||||
|
background: #1d4ed8;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
.store-btn img {
|
||||||
|
width: 20px;
|
||||||
|
height: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.links {
|
||||||
|
margin-top: 1.75rem;
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
gap: 1.5rem;
|
||||||
|
font-size: 0.8125rem;
|
||||||
|
}
|
||||||
|
.links a {
|
||||||
|
color: #71717a;
|
||||||
|
transition: color 0.15s;
|
||||||
|
}
|
||||||
|
.links a:hover {
|
||||||
|
color: #a1a1aa;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="card">
|
||||||
|
<img
|
||||||
|
class="logo"
|
||||||
|
src="https://img.alicdn.com/imgextra/i3/O1CN01JPT4Fj1FJTfmHfNxO_!!6000000000466-49-tps-512-512.webp"
|
||||||
|
alt="Page Agent"
|
||||||
|
/>
|
||||||
|
<div class="badge">Page Agent MCP Launcher</div>
|
||||||
|
|
||||||
|
<div id="connecting">
|
||||||
|
<div class="spinner"></div>
|
||||||
|
<h1 data-i18n="connecting_title">Connecting to Page Agent</h1>
|
||||||
|
<p class="sub" data-i18n="connecting_sub">Opening the hub in your browser…</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="install" class="install">
|
||||||
|
<h1 data-i18n="install_title">Extension Required</h1>
|
||||||
|
<p class="sub" data-i18n="install_sub">
|
||||||
|
Page Agent requires the latest browser extension to work.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<a class="store-btn" href="__STORE_URL__" target="_blank">
|
||||||
|
<img
|
||||||
|
src="https://img.alicdn.com/imgextra/i3/O1CN01JpW0Vo1sR3FpiZKFM_!!6000000005762-55-tps-192-192.svg"
|
||||||
|
alt=""
|
||||||
|
/>
|
||||||
|
<span data-i18n="install_btn">Install from Chrome Web Store</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<ul class="tips">
|
||||||
|
<li data-i18n="tip_outdated">
|
||||||
|
If the extension is outdated, please update it to the latest version.
|
||||||
|
</li>
|
||||||
|
<li data-i18n="tip_other_browser">
|
||||||
|
If the extension is not installed in this browser, open this page from the
|
||||||
|
browser that has it installed.
|
||||||
|
</li>
|
||||||
|
<li data-i18n="tip_refresh">Refresh this page after installing or updating.</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<a href="https://alibaba.github.io/page-agent/docs/introduction/overview" target="_blank" data-i18n="link_docs">Docs</a>
|
||||||
|
<a href="https://github.com/alibaba/page-agent/issues" target="_blank" data-i18n="link_issues">Report an Issue</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
{
|
||||||
|
const EXT_ID = '__EXT_ID__'
|
||||||
|
const wsPort = __WS_PORT__
|
||||||
|
|
||||||
|
const zh = {
|
||||||
|
connecting_title: '正在连接 Page Agent',
|
||||||
|
connecting_sub: '正在浏览器中打开 Hub…',
|
||||||
|
install_title: '需要安装浏览器插件',
|
||||||
|
install_sub: 'Page Agent 需要安装最新版浏览器插件才能运行。',
|
||||||
|
install_btn: '从 Chrome 应用商店安装',
|
||||||
|
tip_outdated: '如果插件版本过旧,请更新到最新版本。',
|
||||||
|
tip_other_browser:
|
||||||
|
'如果该浏览器中未安装插件,请从装有插件的浏览器打开此页面。',
|
||||||
|
tip_refresh: '安装或更新后,请刷新此页面。',
|
||||||
|
link_docs: '文档',
|
||||||
|
link_issues: '问题反馈',
|
||||||
|
}
|
||||||
|
|
||||||
|
if (/^zh\b/i.test(navigator.language)) {
|
||||||
|
document.querySelectorAll('[data-i18n]').forEach((el) => {
|
||||||
|
const key = el.getAttribute('data-i18n')
|
||||||
|
if (zh[key]) el.textContent = zh[key]
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const showInstall = () => {
|
||||||
|
document.getElementById('connecting').style.display = 'none'
|
||||||
|
document.getElementById('install').classList.add('show')
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (!globalThis.chrome?.runtime?.sendMessage) {
|
||||||
|
showInstall()
|
||||||
|
} else {
|
||||||
|
chrome.runtime.sendMessage(
|
||||||
|
EXT_ID,
|
||||||
|
{ type: 'OPEN_HUB', wsPort },
|
||||||
|
(response) => {
|
||||||
|
if (chrome.runtime.lastError || !response?.ok) showInstall()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
showInstall()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -1,16 +1,26 @@
|
|||||||
{
|
{
|
||||||
"name": "page-agent",
|
"name": "page-agent",
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "1.1.0",
|
"version": "1.8.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "./dist/esm/page-agent.js",
|
"main": "./src/PageAgent.ts",
|
||||||
"module": "./dist/esm/page-agent.js",
|
"types": "./src/PageAgent.ts",
|
||||||
"types": "./dist/esm/PageAgent.d.ts",
|
|
||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"types": "./dist/esm/PageAgent.d.ts",
|
"types": "./src/PageAgent.ts",
|
||||||
"import": "./dist/esm/page-agent.js",
|
"default": "./src/PageAgent.ts"
|
||||||
"default": "./dist/esm/page-agent.js"
|
}
|
||||||
|
},
|
||||||
|
"publishConfig": {
|
||||||
|
"main": "./dist/esm/page-agent.js",
|
||||||
|
"module": "./dist/esm/page-agent.js",
|
||||||
|
"types": "./dist/esm/PageAgent.d.ts",
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"types": "./dist/esm/PageAgent.d.ts",
|
||||||
|
"import": "./dist/esm/page-agent.js",
|
||||||
|
"default": "./dist/esm/page-agent.js"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
@@ -40,15 +50,20 @@
|
|||||||
"build": "vite build && npm run build:demo",
|
"build": "vite build && npm run build:demo",
|
||||||
"build:demo": "vite build --config vite.iife.config.js",
|
"build:demo": "vite build --config vite.iife.config.js",
|
||||||
"dev:demo": "concurrently \"vite build --config vite.iife.config.js --watch\" \"npx serve dist/iife -p 5174\"",
|
"dev:demo": "concurrently \"vite build --config vite.iife.config.js --watch\" \"npx serve dist/iife -p 5174\"",
|
||||||
"prepublishOnly": "node -e \"const fs=require('fs');['README.md','LICENSE'].forEach(f=>fs.copyFileSync('../../'+f,f))\"",
|
"prepublishOnly": "node ../../scripts/pre-publish.js",
|
||||||
"postpublish": "node -e \"['README.md','LICENSE'].forEach(f=>{try{require('fs').unlinkSync(f)}catch{}})\""
|
"postpublish": "node ../../scripts/post-publish.js"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"chalk": "^5.6.2",
|
"@page-agent/core": "1.8.0",
|
||||||
"zod": "^4.3.5",
|
"@page-agent/llms": "1.8.0",
|
||||||
"@page-agent/llms": "1.1.0",
|
"@page-agent/page-controller": "1.8.0",
|
||||||
"@page-agent/page-controller": "1.1.0",
|
"@page-agent/ui": "1.8.0",
|
||||||
"@page-agent/core": "1.1.0",
|
"chalk": "^5.6.2"
|
||||||
"@page-agent/ui": "1.1.0"
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"zod": "^3.25.0 || ^4.0.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"zod": "^4.3.6"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,12 +2,13 @@
|
|||||||
* Copyright (C) 2025 Alibaba Group Holding Limited
|
* Copyright (C) 2025 Alibaba Group Holding Limited
|
||||||
* All rights reserved.
|
* All rights reserved.
|
||||||
*/
|
*/
|
||||||
import { type PageAgentConfig, PageAgentCore, type PageAgentTool, tool } from '@page-agent/core'
|
import { type AgentConfig, PageAgentCore } from '@page-agent/core'
|
||||||
import { PageController } from '@page-agent/page-controller'
|
import { PageController, type PageControllerConfig } from '@page-agent/page-controller'
|
||||||
import { Panel } from '@page-agent/ui'
|
import { Panel, type PanelConfig } from '@page-agent/ui'
|
||||||
|
|
||||||
export type { PageAgentConfig, PageAgentTool }
|
export * from '@page-agent/core'
|
||||||
export { tool }
|
|
||||||
|
export type PageAgentConfig = AgentConfig & PageControllerConfig & Omit<PanelConfig, 'language'>
|
||||||
|
|
||||||
export class PageAgent extends PageAgentCore {
|
export class PageAgent extends PageAgentCore {
|
||||||
panel: Panel
|
panel: Panel
|
||||||
@@ -22,6 +23,7 @@ export class PageAgent extends PageAgentCore {
|
|||||||
|
|
||||||
this.panel = new Panel(this, {
|
this.panel = new Panel(this, {
|
||||||
language: config.language,
|
language: config.language,
|
||||||
|
promptForNextTask: config.promptForNextTask,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user