@gavin-hu/my-pi-agent 0.12.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -21
- package/README.zh-CN.md +30 -22
- package/extensions/bytefly/README.md +139 -67
- package/extensions/bytefly/chrome.ts +7 -2
- package/extensions/bytefly/doctor/register.ts +6 -0
- package/extensions/bytefly/doctor/runtime.ts +36 -6
- package/extensions/bytefly/footer/collect/snapshot.ts +12 -2
- package/extensions/bytefly/footer/config.ts +7 -1
- package/extensions/bytefly/footer/delegation.ts +100 -0
- package/extensions/bytefly/footer/register.ts +13 -2
- package/extensions/bytefly/footer/render/lines.ts +2 -0
- package/extensions/bytefly/footer/render/segments.ts +27 -0
- package/extensions/bytefly/footer/types.ts +11 -0
- package/extensions/bytefly/index.ts +4 -3
- package/extensions/bytefly/notify/config.ts +2 -0
- package/extensions/bytefly/notify/format.ts +19 -1
- package/extensions/bytefly/notify/register.ts +37 -13
- package/extensions/bytefly/notify/types.ts +2 -0
- package/extensions/bytefly/panel/commands.ts +34 -13
- package/extensions/bytefly/panel/settings.ts +98 -16
- package/extensions/bytefly/update/cache.ts +73 -0
- package/extensions/bytefly/update/format.ts +65 -10
- package/extensions/bytefly/update/register.ts +99 -13
- package/extensions/bytefly/update/state.ts +13 -1
- package/extensions/document/README.md +22 -12
- package/extensions/document/config.ts +4 -0
- package/extensions/document/deadline.ts +61 -0
- package/extensions/document/tool.ts +13 -2
- package/extensions/file-browse/README.md +12 -8
- package/extensions/file-browse/client.ts +6 -7
- package/extensions/file-browse/files.ts +0 -4
- package/extensions/file-browse/git.ts +9 -10
- package/extensions/file-browse/html.ts +17 -7
- package/extensions/file-browse/router.ts +24 -15
- package/extensions/goal/README.md +7 -1
- package/extensions/goal/schema.ts +6 -2
- package/extensions/goal/types.ts +6 -2
- package/extensions/job/README.md +16 -12
- package/extensions/job/runtime.ts +23 -6
- package/extensions/job/status.ts +4 -2
- package/extensions/memory/README.md +55 -13
- package/extensions/memory/commands.ts +20 -2
- package/extensions/memory/doctor.ts +137 -0
- package/extensions/memory/format.ts +24 -7
- package/extensions/memory/runtime.ts +49 -0
- package/extensions/memory/store.ts +31 -0
- package/extensions/memory/tui.ts +136 -12
- package/extensions/plan/README.md +60 -29
- package/extensions/plan/commands.ts +67 -8
- package/extensions/plan/index.ts +35 -11
- package/extensions/plan/plan-index.ts +234 -0
- package/extensions/plan/plan-text.ts +95 -0
- package/extensions/plan/plans.ts +90 -1
- package/extensions/plan/review.ts +12 -9
- package/extensions/plan/runtime.ts +72 -27
- package/extensions/plan/steps.ts +35 -25
- package/extensions/plan/todos.ts +24 -2
- package/extensions/plan/tools.ts +124 -24
- package/extensions/plan/tui.ts +7 -28
- package/extensions/plan/types.ts +9 -0
- package/extensions/plan/web-page.ts +2 -2
- package/extensions/plan/web.ts +12 -11
- package/extensions/rewind/README.md +28 -8
- package/extensions/rewind/commands.ts +1 -1
- package/extensions/rewind/format.ts +4 -4
- package/extensions/rewind/git.ts +56 -18
- package/extensions/rewind/index.ts +3 -5
- package/extensions/rewind/path-picker.ts +198 -0
- package/extensions/rewind/paths.ts +128 -0
- package/extensions/rewind/restore.ts +69 -28
- package/extensions/rewind/rewind.ts +80 -3
- package/extensions/rewind/runtime.ts +13 -5
- package/extensions/rewind/snapshot-run.ts +5 -2
- package/extensions/rewind/types.ts +2 -0
- package/extensions/subagent/README.md +7 -1
- package/extensions/subagent/accounting.ts +34 -0
- package/extensions/subagent/index.ts +23 -1
- package/extensions/subagent/stream.ts +2 -0
- package/extensions/subagent/types.ts +2 -0
- package/extensions/watch/README.md +8 -3
- package/extensions/watch/index.ts +19 -0
- package/extensions/web-access/README.md +43 -13
- package/extensions/web-access/charset.ts +58 -0
- package/extensions/web-access/fetch/find.ts +11 -7
- package/extensions/web-access/fetch/format.ts +64 -18
- package/extensions/web-access/fetch/page.ts +5 -1
- package/extensions/web-access/fetch/tool.ts +19 -18
- package/extensions/web-access/http.ts +49 -8
- package/extensions/web-access/search/facts.ts +38 -0
- package/extensions/web-access/search/tool.ts +13 -0
- package/extensions/web-access/text.ts +50 -11
- package/extensions/worktree/README.md +74 -15
- package/extensions/worktree/config.ts +11 -0
- package/extensions/worktree/exit.ts +35 -3
- package/extensions/worktree/gaps.ts +74 -0
- package/extensions/worktree/guard.ts +50 -4
- package/extensions/worktree/handoff.ts +55 -0
- package/extensions/worktree/index.ts +12 -2
- package/extensions/worktree/runtime.ts +20 -0
- package/extensions/worktree/status.ts +15 -2
- package/extensions/worktree/tools.ts +3 -2
- package/lib/README.md +10 -8
- package/lib/events.ts +86 -1
- package/lib/goal-state.ts +95 -0
- package/lib/requirements.ts +282 -62
- package/lib/tui/README.md +91 -0
- package/lib/tui/glyphs.ts +1 -0
- package/lib/web/layout.ts +12 -2
- package/package.json +5 -3
- package/themes/bytefly-dark.json +1 -1
- package/assets/chrome.png +0 -0
- package/assets/file-browse.png +0 -0
- package/assets/job.png +0 -0
- package/assets/plan-review.png +0 -0
- package/assets/question.png +0 -0
- package/assets/rewind.png +0 -0
- package/assets/todo.png +0 -0
- package/assets/tool-renderings.png +0 -0
- package/assets/tools/ask_user_question-cancelled.png +0 -0
- package/assets/tools/ask_user_question.png +0 -0
- package/assets/tools/bash.png +0 -0
- package/assets/tools/edit.png +0 -0
- package/assets/tools/enter_plan_mode.png +0 -0
- package/assets/tools/enter_worktree.png +0 -0
- package/assets/tools/exit_plan_mode.png +0 -0
- package/assets/tools/exit_worktree.png +0 -0
- package/assets/tools/find.png +0 -0
- package/assets/tools/goal.png +0 -0
- package/assets/tools/grep.png +0 -0
- package/assets/tools/job.png +0 -0
- package/assets/tools/list_worktrees.png +0 -0
- package/assets/tools/ls.png +0 -0
- package/assets/tools/memory-long-subject.png +0 -0
- package/assets/tools/memory.png +0 -0
- package/assets/tools/notice.png +0 -0
- package/assets/tools/open_path.png +0 -0
- package/assets/tools/prune_worktrees.png +0 -0
- package/assets/tools/read.png +0 -0
- package/assets/tools/read_doc-running.png +0 -0
- package/assets/tools/read_doc.png +0 -0
- package/assets/tools/run_doctor.png +0 -0
- package/assets/tools/send_wechat.png +0 -0
- package/assets/tools/set_plan_steps.png +0 -0
- package/assets/tools/subagent.png +0 -0
- package/assets/tools/todo.png +0 -0
- package/assets/tools/turn-rule.png +0 -0
- package/assets/tools/user-message.png +0 -0
- package/assets/tools/watch.png +0 -0
- package/assets/tools/web_fetch-rejected.png +0 -0
- package/assets/tools/web_fetch.png +0 -0
- package/assets/tools/web_search.png +0 -0
- package/assets/tools/write.png +0 -0
- package/assets/tools/write_plan.png +0 -0
|
@@ -15,8 +15,11 @@ import { createSnapshotPolicy, type SnapshotPolicy } from "./policy.ts";
|
|
|
15
15
|
import type { RewindRuntime } from "./runtime.ts";
|
|
16
16
|
|
|
17
17
|
export interface SnapshotRun {
|
|
18
|
-
/**
|
|
19
|
-
|
|
18
|
+
/**
|
|
19
|
+
* Start a run for `prompt` — `undefined` when a custom message started it: reset
|
|
20
|
+
* run state and resolve the snapshot decision.
|
|
21
|
+
*/
|
|
22
|
+
beginRun(prompt: string | undefined, ctx: ExtensionContext): Promise<void>;
|
|
20
23
|
/** Take the run's single snapshot before the first mutating call, at most once. */
|
|
21
24
|
onToolCall(toolName: string, ctx: ExtensionContext): Promise<void>;
|
|
22
25
|
/** Drop run-scoped state (on session shutdown). */
|
|
@@ -53,6 +53,8 @@ export interface RestoreSummary {
|
|
|
53
53
|
changed: number;
|
|
54
54
|
/** Files deleted because they were created after the snapshot. */
|
|
55
55
|
removed: number;
|
|
56
|
+
/** Paths the whole diff touched, present only when a subset was restored. */
|
|
57
|
+
of?: number;
|
|
56
58
|
/** Id of the pre-restore safety snapshot, when one was taken. */
|
|
57
59
|
safety?: string;
|
|
58
60
|
}
|
|
@@ -236,7 +236,13 @@ step's `Output`.
|
|
|
236
236
|
they are not written to the parent session.
|
|
237
237
|
- **No cost attribution to the parent session.** A subagent's tokens and cost are
|
|
238
238
|
captured in the tool result and shown in the transcript, but they belong to a
|
|
239
|
-
separate process and are not added to the dispatching session's totals.
|
|
239
|
+
separate process and are not added to the dispatching session's totals. Instead,
|
|
240
|
+
each finished run publishes `my-pi-agent/subagent-finished`
|
|
241
|
+
(`SubagentFinishedEvent` in `lib/events.ts`) and bytefly's footer shows the
|
|
242
|
+
session's child runs as their own `↳` roll-up, priced separately from the
|
|
243
|
+
session total (the last 500 runs). The roll-up is per process: a resumed session
|
|
244
|
+
starts from zero, and a run that never produced an assistant message publishes
|
|
245
|
+
nothing.
|
|
240
246
|
|
|
241
247
|
## Pi integration
|
|
242
248
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The accounting event a finished child run publishes.
|
|
3
|
+
*
|
|
4
|
+
* `subagent` runs each child in its own `pi` process, so the dispatcher's own
|
|
5
|
+
* usage totals never include what the child spent. The event carries the child's
|
|
6
|
+
* pricing inputs (provider, model, token counts, Pi's recorded dollar cost, finish
|
|
7
|
+
* time) rather than a total, so the consumer can price them with the same rate
|
|
8
|
+
* table and currency it uses for the session — and re-price them after a currency
|
|
9
|
+
* change.
|
|
10
|
+
*
|
|
11
|
+
* A run with no assistant message spent nothing observable (an unknown agent, a
|
|
12
|
+
* spawn failure), so it publishes nothing at all.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import type { SubagentFinishedEvent } from "../../lib/events.ts";
|
|
16
|
+
import type { SingleResult } from "./types.ts";
|
|
17
|
+
|
|
18
|
+
/** The event for one finished run, or `null` when it produced no usage. */
|
|
19
|
+
export function finishedEvent(result: SingleResult): SubagentFinishedEvent | null {
|
|
20
|
+
const { usage } = result;
|
|
21
|
+
if (usage.turns === 0) return null;
|
|
22
|
+
return {
|
|
23
|
+
agent: result.agent,
|
|
24
|
+
provider: result.provider ?? null,
|
|
25
|
+
model: result.model ?? null,
|
|
26
|
+
input: usage.input,
|
|
27
|
+
output: usage.output,
|
|
28
|
+
cacheRead: usage.cacheRead,
|
|
29
|
+
cacheWrite: usage.cacheWrite,
|
|
30
|
+
recordedCost: usage.cost,
|
|
31
|
+
at: result.finishedAt ?? null,
|
|
32
|
+
exitCode: result.exitCode,
|
|
33
|
+
};
|
|
34
|
+
}
|
|
@@ -27,6 +27,8 @@ import {
|
|
|
27
27
|
} from "./agents.ts";
|
|
28
28
|
import { runChainMode, runParallelMode, runSingleMode, type ModeContext } from "./orchestrate.ts";
|
|
29
29
|
import { renderSubagentCall, renderSubagentResult } from "./render.ts";
|
|
30
|
+
import { SUBAGENT_FINISHED_CHANNEL } from "../../lib/events.ts";
|
|
31
|
+
import { finishedEvent } from "./accounting.ts";
|
|
30
32
|
import { runSingleAgent, type RunOptions } from "./run.ts";
|
|
31
33
|
import { SubagentParams, resolveMode, type SubagentArgs } from "./schema.ts";
|
|
32
34
|
import type { DispatchDefaults, SingleResult, SubagentDetails } from "./types.ts";
|
|
@@ -65,7 +67,27 @@ function requestedAgentNames(args: SubagentArgs): string[] {
|
|
|
65
67
|
|
|
66
68
|
export default function subagent(pi: ExtensionAPI, deps: SubagentDeps = {}): void {
|
|
67
69
|
if (!isExtensionEnabled("subagent")) return;
|
|
68
|
-
const
|
|
70
|
+
const runner = deps.run ?? runSingleAgent;
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Account for each finished child, then hand the result on unchanged.
|
|
74
|
+
*
|
|
75
|
+
* Every mode (`single`, `parallel` per task, `chain` per step) calls this once
|
|
76
|
+
* per child, so one wrapper reports each run exactly once. The emit is guarded:
|
|
77
|
+
* a bus listener that throws must not fail a delegation that already ran.
|
|
78
|
+
*/
|
|
79
|
+
const run = async (options: RunOptions): Promise<SingleResult> => {
|
|
80
|
+
const result = await runner(options);
|
|
81
|
+
const event = finishedEvent(result);
|
|
82
|
+
if (event) {
|
|
83
|
+
try {
|
|
84
|
+
pi.events.emit(SUBAGENT_FINISHED_CHANNEL, event);
|
|
85
|
+
} catch {
|
|
86
|
+
// Accounting is best-effort; the run's own result is what matters.
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
return result;
|
|
90
|
+
};
|
|
69
91
|
|
|
70
92
|
pi.registerTool({
|
|
71
93
|
name: TOOL_NAME,
|
|
@@ -47,6 +47,7 @@ export function applyEvent(result: SingleResult, event: unknown): boolean {
|
|
|
47
47
|
|
|
48
48
|
if (message.role === "assistant") {
|
|
49
49
|
const assistant = message as Message & {
|
|
50
|
+
provider?: string;
|
|
50
51
|
model?: string;
|
|
51
52
|
stopReason?: string;
|
|
52
53
|
errorMessage?: string;
|
|
@@ -69,6 +70,7 @@ export function applyEvent(result: SingleResult, event: unknown): boolean {
|
|
|
69
70
|
result.usage.cost += usage.cost?.total ?? 0;
|
|
70
71
|
result.usage.contextTokens = usage.totalTokens ?? result.usage.contextTokens;
|
|
71
72
|
}
|
|
73
|
+
if (!result.provider && assistant.provider) result.provider = assistant.provider;
|
|
72
74
|
if (!result.model && assistant.model) result.model = assistant.model;
|
|
73
75
|
if (assistant.stopReason) result.stopReason = assistant.stopReason;
|
|
74
76
|
if (assistant.errorMessage) result.errorMessage = assistant.errorMessage;
|
|
@@ -37,6 +37,8 @@ export interface SingleResult {
|
|
|
37
37
|
messages: Message[];
|
|
38
38
|
stderr: string;
|
|
39
39
|
usage: UsageStats;
|
|
40
|
+
/** Provider and model the child reported; published for the accounting event. */
|
|
41
|
+
provider?: string;
|
|
40
42
|
model?: string;
|
|
41
43
|
stopReason?: string;
|
|
42
44
|
errorMessage?: string;
|
|
@@ -29,7 +29,10 @@ How the `watch` call and its result look in the transcript — the call line as
|
|
|
29
29
|
- Shows a `⊚ N` running-watcher chip and a `! N` unreported-match chip, raises a
|
|
30
30
|
`ctx.ui.notify` alert once per unreported burst, and offers a `/watch` screen.
|
|
31
31
|
- Reports pending matches to the model at the start of the next turn, or wakes a
|
|
32
|
-
turn for a watcher added with `wake: true`.
|
|
32
|
+
turn for a watcher added with `wake: true`. A wake also leaves the terminal: the
|
|
33
|
+
match is announced on `my-pi-agent/watch-match`, which bytefly's
|
|
34
|
+
[notify](../bytefly/README.md#notifications) capability turns into a desktop
|
|
35
|
+
notification when `notify.enabled` and `notify.matchFound` are on.
|
|
33
36
|
- Watchers are session-only: `shutdown` flushes a partial line, kills every
|
|
34
37
|
command's process tree, and clears the chips.
|
|
35
38
|
|
|
@@ -162,12 +165,14 @@ other.
|
|
|
162
165
|
- `matches` and `logs` keep bounded histories (`maxMatches`/`maxLogLines`), so
|
|
163
166
|
older lines are dropped.
|
|
164
167
|
- Matching is per line; a pattern cannot span a newline.
|
|
168
|
+
- Only a **wake** match raises an OS notification, and only when bytefly's
|
|
169
|
+
`notify.enabled` and `notify.matchFound` are on. A match collected while the
|
|
170
|
+
agent was busy is reported at the next turn without a notification, and `watch`
|
|
171
|
+
itself never sends one — it announces the match and bytefly owns delivery.
|
|
165
172
|
|
|
166
173
|
## Non-goals
|
|
167
174
|
|
|
168
175
|
- Persisting or reattaching watchers across sessions.
|
|
169
|
-
- Notifying through bytefly's OS-notification capability (the `job` extension
|
|
170
|
-
owns that channel; `watch` alerts in-session with `ctx.ui.notify`).
|
|
171
176
|
- Multiline or stateful matching, log rotation hooks, and per-watcher poll
|
|
172
177
|
intervals.
|
|
173
178
|
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
|
|
14
14
|
import { isExtensionEnabled } from "../../lib/env.ts";
|
|
15
|
+
import { WATCH_MATCH_CHANNEL, type WatchMatchEvent } from "../../lib/events.ts";
|
|
15
16
|
import { sanitizeLine } from "../../lib/format.ts";
|
|
16
17
|
import { noticeMessage, type NoticeMessage, pruneStaleNotices } from "../../lib/notice.ts";
|
|
17
18
|
import { STATUS_KEYS } from "../../lib/tui/glyphs.ts";
|
|
@@ -80,6 +81,24 @@ export default function watch(pi: ExtensionAPI, deps: WatchDeps = {}): void {
|
|
|
80
81
|
waking = true;
|
|
81
82
|
} catch {
|
|
82
83
|
// Waking is best-effort; the next turn still reports the matches.
|
|
84
|
+
return;
|
|
85
|
+
}
|
|
86
|
+
// A wake means the user is away from the terminal, so the alert also leaves
|
|
87
|
+
// the process. bytefly's notify capability owns delivery; this publishes the
|
|
88
|
+
// fact and never learns how it is sent. The newest match is the one an alert
|
|
89
|
+
// is about, while the count covers the whole cycle.
|
|
90
|
+
const newest = pending[pending.length - 1];
|
|
91
|
+
if (!newest) return;
|
|
92
|
+
try {
|
|
93
|
+
const event: WatchMatchEvent = {
|
|
94
|
+
count: pending.length,
|
|
95
|
+
watcherId: newest.watcherId,
|
|
96
|
+
label: newest.label,
|
|
97
|
+
line: newest.line,
|
|
98
|
+
};
|
|
99
|
+
pi.events.emit(WATCH_MATCH_CHANNEL, event);
|
|
100
|
+
} catch {
|
|
101
|
+
// A throwing listener must not cost the wake that already happened.
|
|
83
102
|
}
|
|
84
103
|
};
|
|
85
104
|
|
|
@@ -28,6 +28,9 @@ How the `web_search` and `web_fetch` calls and their results look in the transcr
|
|
|
28
28
|
always with no configuration required.
|
|
29
29
|
- Registers `web_fetch`, which fetches a URL (GET or POST) and
|
|
30
30
|
returns readable text with links kept as `[text](url)`.
|
|
31
|
+
- Decodes by the byte-order mark, the declared `Content-Type` charset, or the
|
|
32
|
+
page's own `<meta charset>`, so a GBK/GB18030 page reads as text instead of
|
|
33
|
+
replacement characters.
|
|
31
34
|
- Pages long output and reports the next `startIndex` (`nextIndex` in
|
|
32
35
|
`structuredContent`); `find` returns matching passages instead of the whole
|
|
33
36
|
page, and says when the match cap hid further hits.
|
|
@@ -148,6 +151,8 @@ as `Authorization: Bearer <key>`; for Brave it is sent as
|
|
|
148
151
|
cannot redirect into a private address.
|
|
149
152
|
- Transport headers (`Host`, `Content-Length`, `Connection`, `Transfer-Encoding`,
|
|
150
153
|
and similar) are refused, and request bodies are capped.
|
|
154
|
+
- `maxBytes` is enforced while the body streams in: a chunked or compressed
|
|
155
|
+
response is abandoned at the limit instead of being buffered whole.
|
|
151
156
|
|
|
152
157
|
## `web_search`
|
|
153
158
|
|
|
@@ -173,6 +178,13 @@ The SearXNG instance must have the **JSON API enabled** (`format=json` in its
|
|
|
173
178
|
`settings.yml`); most public instances disable it, so a self-hosted instance is
|
|
174
179
|
recommended. If the response is not JSON, the error says so.
|
|
175
180
|
|
|
181
|
+
`run_doctor` reports what this session actually resolved to — the provider id and
|
|
182
|
+
whether it came from an explicit choice, the `auto` rule, or the keyless default;
|
|
183
|
+
the API-key variable when the provider takes one and no literal `apiKey` is set,
|
|
184
|
+
and whether that variable is present; and, only on an explicit `refresh`, whether
|
|
185
|
+
the configured `endpoint` answers. The key is never reported, only its variable
|
|
186
|
+
name. See [`bytefly`](../bytefly/README.md#what-it-does) for the report.
|
|
187
|
+
|
|
176
188
|
| Parameter | Type | Notes |
|
|
177
189
|
|---|---|---|
|
|
178
190
|
| `query` | string | 1–400 chars, required, any language |
|
|
@@ -200,7 +212,7 @@ address. Loopback, private, link-local, and cloud-metadata addresses are refused
|
|
|
200
212
|
| `headers` | object | Extra request headers (transport headers are refused) |
|
|
201
213
|
| `body` | string | POST body; implies `method: "POST"` unless set explicitly |
|
|
202
214
|
| `startIndex` | integer | Code-point offset to start from (default 0) |
|
|
203
|
-
| `maxChars` | integer | ≥200; capped by `maxOutputChars` |
|
|
215
|
+
| `maxChars` | integer | ≥200; capped by `maxOutputChars`; also caps `find` output |
|
|
204
216
|
| `find` | string[] | 1–10 strings; return matching passages instead of the page |
|
|
205
217
|
| `mode` | enum | `insensitive` (default) \| `exact` \| `fuzzy` |
|
|
206
218
|
| `contextChars` | integer | 0–2000 chars of context per match (default 200) |
|
|
@@ -209,10 +221,14 @@ address. Loopback, private, link-local, and cloud-metadata addresses are refused
|
|
|
209
221
|
|
|
210
222
|
Long pages are paged: a truncated page names the `startIndex` to use next, inside
|
|
211
223
|
its own character budget, and `structuredContent` repeats it as `nextIndex`.
|
|
212
|
-
|
|
213
|
-
|
|
224
|
+
A `find` result spends the same `maxChars` budget: passages are added while they
|
|
225
|
+
fit, and the note names `maxMatches` when the match cap hid the rest or
|
|
226
|
+
`maxChars`/`contextChars` when the budget did. Fetched pages are cached for the
|
|
227
|
+
registration, so paging and `find` do not refetch. POST responses and requests
|
|
228
|
+
with custom headers are never cached.
|
|
214
229
|
`structuredContent` is the page object, with an `error` field when the fetch
|
|
215
|
-
failed and `matchesTruncated` when
|
|
230
|
+
failed and `matchesTruncated` when the match cap or the `maxChars` budget hid
|
|
231
|
+
matches.
|
|
216
232
|
|
|
217
233
|
```
|
|
218
234
|
web_fetch({ url: "https://pi.dev/" })
|
|
@@ -243,6 +259,9 @@ the content type and size.
|
|
|
243
259
|
- **Heuristic extraction**: `web_fetch` strips scripts/styles/nav/footer and
|
|
244
260
|
prefers `<main>`/`<article>`, but is not a full readability engine. PDF
|
|
245
261
|
extraction is optional (`unpdf`) and off unless installed.
|
|
262
|
+
- **`find` output is budgeted.** With `maxMatches: 50` and `contextChars: 2000`
|
|
263
|
+
the passages alone would exceed `maxOutputChars`; the result shows the passages
|
|
264
|
+
that fit and names the knob to change.
|
|
246
265
|
- **The page cache is in-memory and per registration**; a page can be stale
|
|
247
266
|
within a session. `refresh: true` refetches, and it is cleared on
|
|
248
267
|
`session_start` and `session_shutdown`.
|
|
@@ -279,7 +298,12 @@ the content type and size.
|
|
|
279
298
|
live at the top level (`text.ts`, `html.ts`, `transcript.ts`, `http.ts`).
|
|
280
299
|
- **Shared transport.** [`http.ts`](./http.ts) holds the fetch runner
|
|
281
300
|
(`HttpRunner`, `createFetchRunner`, HTTP error types), used by both halves and
|
|
282
|
-
injectable for tests.
|
|
301
|
+
injectable for tests. It reads the body through a byte-counting stream, so
|
|
302
|
+
`maxBytes` stops a chunked or compressed response before it is buffered whole.
|
|
303
|
+
- **Charset-aware decoding.** [`charset.ts`](./charset.ts) is the one place a
|
|
304
|
+
byte body becomes text: BOM first, then the declared `Content-Type` charset,
|
|
305
|
+
then the page's own `<meta charset>`, then UTF-8. An unknown label falls back
|
|
306
|
+
to UTF-8 instead of failing the fetch.
|
|
283
307
|
- **One config file, isolated sections.** `config.ts` reads the global then
|
|
284
308
|
project file and validates each section with its half's normalizer; unknown
|
|
285
309
|
keys and malformed files are ignored.
|
|
@@ -302,7 +326,11 @@ the content type and size.
|
|
|
302
326
|
mutable is held at module scope.
|
|
303
327
|
- **The paging budget is explicit.** `formatPage` counts the header and the
|
|
304
328
|
truncation note against `maxChars`, so a paged page always carries its
|
|
305
|
-
`startIndex` hint inside the limit.
|
|
329
|
+
`startIndex` hint inside the limit. `formatMatches` applies the same rule to
|
|
330
|
+
`find`: it includes the passages that fit and names the knob that hid the rest.
|
|
331
|
+
- **Code points without a copy.** [`text.ts`](./text.ts) counts and slices by
|
|
332
|
+
walking the string in place, so a multi-megabyte page is never expanded into an
|
|
333
|
+
array of one-character strings on every call.
|
|
306
334
|
- **One JSON boundary per concern.** `search/json.ts` owns `requestJson` (status
|
|
307
335
|
check and parse error) and `collectResults` (title + http(s) URL + de-dupe), so
|
|
308
336
|
the three providers cannot drift on either.
|
|
@@ -321,7 +349,8 @@ the content type and size.
|
|
|
321
349
|
|---|---|
|
|
322
350
|
| `index.ts` | Register both tools |
|
|
323
351
|
| `config.ts` | The `web-access` section of `bytefly.json` loader (via `lib/config.ts`) |
|
|
324
|
-
| `http.ts` | Shared fetch runner and HTTP error types |
|
|
352
|
+
| `http.ts` | Shared fetch runner and HTTP error types; caps the body while streaming |
|
|
353
|
+
| `charset.ts` | Charset-aware body decoding (BOM, header, `<meta>`, UTF-8 fallback) |
|
|
325
354
|
| `text.ts` | Shared code-point length, slice, and truncation helpers |
|
|
326
355
|
| `html.ts` | Shared HTML entity decoding |
|
|
327
356
|
| `transcript.ts` | Shared `oneLine` sanitizer for both transcript renderers |
|
|
@@ -353,11 +382,12 @@ the content type and size.
|
|
|
353
382
|
`config.test.ts` and `index.test.ts`. It covers the shared runner (via injected
|
|
354
383
|
`fetch`), the provider registry and resolution, each provider's URL builder and
|
|
355
384
|
parser (DuckDuckGo, SearXNG, Brave), the orchestration pipeline and throttle,
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
registration
|
|
385
|
+
charset decoding (declared, `<meta>`, and BOM precedence), a streamed body over
|
|
386
|
+
the byte cap, redirect re-validation (per-hop SSRF with literal IPs),
|
|
387
|
+
method/header/body validation, the nested config merge and section isolation,
|
|
388
|
+
extraction, formatting/paging through the tool (including a regression test that
|
|
389
|
+
a truncated page keeps its `startIndex` hint), find and its cap/budget notices,
|
|
390
|
+
the per-registration cache, the SSRF guard, the injected PDF dependency, and both
|
|
391
|
+
tools' registration/execution. Tests inject the runner, throttle, and PDF extractor
|
|
362
392
|
through the tools' dependencies, so no network or PDF library is needed; the
|
|
363
393
|
runtime smoke test only asserts registration.
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Charset-aware body decoding shared by the web-access halves.
|
|
3
|
+
*
|
|
4
|
+
* HTTP lets a response name its encoding in `Content-Type`, and an HTML page can
|
|
5
|
+
* name one in its markup, so decoding every body as UTF-8 turns a GBK/GB18030
|
|
6
|
+
* page into replacement characters. `http.ts` honours the BOM and the declared
|
|
7
|
+
* charset; `page.ts` adds the `<meta charset>` fallback for HTML. An unknown
|
|
8
|
+
* label falls back to UTF-8 instead of failing the fetch.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
const FALLBACK_CHARSET = "utf-8";
|
|
12
|
+
|
|
13
|
+
/** How much of an HTML document is scanned for a `<meta charset>` declaration. */
|
|
14
|
+
const SNIFF_BYTES = 4096;
|
|
15
|
+
|
|
16
|
+
/** The `charset` parameter of a content type, lowercased. */
|
|
17
|
+
export function charsetOf(contentType: string): string | undefined {
|
|
18
|
+
const match = /;\s*charset\s*=\s*"?([^";\s]+)"?/i.exec(contentType);
|
|
19
|
+
return match?.[1]?.toLowerCase();
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/** The charset a leading byte-order mark declares. */
|
|
23
|
+
export function bomCharset(bytes: Uint8Array): string | undefined {
|
|
24
|
+
if (bytes.length >= 3 && bytes[0] === 0xef && bytes[1] === 0xbb && bytes[2] === 0xbf) return "utf-8";
|
|
25
|
+
if (bytes.length >= 2 && bytes[0] === 0xff && bytes[1] === 0xfe) return "utf-16le";
|
|
26
|
+
if (bytes.length >= 2 && bytes[0] === 0xfe && bytes[1] === 0xff) return "utf-16be";
|
|
27
|
+
return undefined;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* The charset a document declares in its first few kilobytes. Both
|
|
32
|
+
* `<meta charset="gbk">` and `<meta http-equiv="content-type" content="text/html; charset=gbk">`
|
|
33
|
+
* are matched by the same `charset=` scan.
|
|
34
|
+
*/
|
|
35
|
+
export function sniffHtmlCharset(bytes: Uint8Array): string | undefined {
|
|
36
|
+
// Latin-1 keeps every byte addressable and ASCII tags intact.
|
|
37
|
+
const head = new TextDecoder("latin1").decode(bytes.subarray(0, SNIFF_BYTES));
|
|
38
|
+
const match = /<meta[^>]+charset\s*=\s*["']?\s*([a-z0-9_.:-]+)/i.exec(head);
|
|
39
|
+
return match?.[1]?.toLowerCase();
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/** The label type `TextDecoder` accepts; a runtime label is validated by the constructor. */
|
|
43
|
+
type DecoderLabel = ConstructorParameters<typeof TextDecoder>[0];
|
|
44
|
+
|
|
45
|
+
/** Decode bytes with `charset`, falling back to UTF-8 for an absent or unknown label. */
|
|
46
|
+
export function decodeBytes(bytes: Uint8Array, charset?: string): string {
|
|
47
|
+
if (!charset) return new TextDecoder(FALLBACK_CHARSET).decode(bytes);
|
|
48
|
+
try {
|
|
49
|
+
return new TextDecoder(charset as DecoderLabel).decode(bytes);
|
|
50
|
+
} catch {
|
|
51
|
+
return new TextDecoder(FALLBACK_CHARSET).decode(bytes);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/** Decode an HTML body: BOM first, then the declared charset, then its own `<meta>`, then UTF-8. */
|
|
56
|
+
export function decodeHtml(bytes: Uint8Array, contentType: string): string {
|
|
57
|
+
return decodeBytes(bytes, bomCharset(bytes) ?? charsetOf(contentType) ?? sniffHtmlCharset(bytes));
|
|
58
|
+
}
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* model already receives, not the raw HTML.
|
|
14
14
|
*/
|
|
15
15
|
|
|
16
|
-
import {
|
|
16
|
+
import { charLength, sliceChars } from "../text.ts";
|
|
17
17
|
|
|
18
18
|
export type FindMode = "insensitive" | "exact" | "fuzzy";
|
|
19
19
|
|
|
@@ -46,12 +46,12 @@ export function toCodePointOffset(text: string, utf16Index: number): number {
|
|
|
46
46
|
return offset;
|
|
47
47
|
}
|
|
48
48
|
|
|
49
|
-
function passageAround(
|
|
49
|
+
function passageAround(text: string, start: number, end: number, contextChars: number, total: number): string {
|
|
50
50
|
const from = Math.max(0, start - contextChars);
|
|
51
|
-
const to = Math.min(
|
|
51
|
+
const to = Math.min(total, end + contextChars);
|
|
52
52
|
const prefix = from > 0 ? "…" : "";
|
|
53
|
-
const suffix = to <
|
|
54
|
-
return `${prefix}${
|
|
53
|
+
const suffix = to < total ? "…" : "";
|
|
54
|
+
return `${prefix}${sliceChars(text, from, to).trim()}${suffix}`;
|
|
55
55
|
}
|
|
56
56
|
|
|
57
57
|
function substringMatches(text: string, query: string, insensitive: boolean): Array<[number, number]> {
|
|
@@ -131,7 +131,7 @@ function fuzzyMatches(text: string, query: string): Array<[number, number]> {
|
|
|
131
131
|
*/
|
|
132
132
|
export function findPassages(text: string, queries: string[], options: FindOptions): Passage[] {
|
|
133
133
|
if (text.length === 0) return [];
|
|
134
|
-
const
|
|
134
|
+
const total = charLength(text);
|
|
135
135
|
const results: Passage[] = [];
|
|
136
136
|
const seen = new Set<string>();
|
|
137
137
|
|
|
@@ -150,7 +150,11 @@ export function findPassages(text: string, queries: string[], options: FindOptio
|
|
|
150
150
|
if (seen.has(key)) continue;
|
|
151
151
|
seen.add(key);
|
|
152
152
|
const endOffset = toCodePointOffset(text, end);
|
|
153
|
-
results.push({
|
|
153
|
+
results.push({
|
|
154
|
+
query: trimmed,
|
|
155
|
+
offset,
|
|
156
|
+
passage: passageAround(text, offset, endOffset, options.contextChars, total),
|
|
157
|
+
});
|
|
154
158
|
}
|
|
155
159
|
}
|
|
156
160
|
|
|
@@ -5,10 +5,14 @@
|
|
|
5
5
|
* and the truncation note — within `maxChars`. The header and the note are
|
|
6
6
|
* counted against the budget up front, so the "call web_fetch again with
|
|
7
7
|
* startIndex=" instruction always survives inside the limit.
|
|
8
|
-
*
|
|
8
|
+
*
|
|
9
|
+
* `formatMatches` renders find-in-page passages with their offsets inside the
|
|
10
|
+
* same budget: it includes as many passages as fit and says which knob to turn
|
|
11
|
+
* when it had to drop the rest, rather than returning every match the caller
|
|
12
|
+
* allowed.
|
|
9
13
|
*/
|
|
10
14
|
|
|
11
|
-
import { charLength,
|
|
15
|
+
import { charLength, sliceChars, truncateChars } from "../text.ts";
|
|
12
16
|
import type { Passage } from "./find.ts";
|
|
13
17
|
|
|
14
18
|
interface PageFormatInput {
|
|
@@ -46,8 +50,7 @@ function truncationNote(nextIndex: number, total: number): string {
|
|
|
46
50
|
}
|
|
47
51
|
|
|
48
52
|
export function formatPage(input: PageFormatInput): FormattedPage {
|
|
49
|
-
const
|
|
50
|
-
const total = points.length;
|
|
53
|
+
const total = charLength(input.text);
|
|
51
54
|
const header = pageHeader(input.title, input.finalUrl, input.status, input.contentType);
|
|
52
55
|
|
|
53
56
|
if (total === 0) {
|
|
@@ -68,15 +71,14 @@ export function formatPage(input: PageFormatInput): FormattedPage {
|
|
|
68
71
|
// `total` for both offsets gives the widest digit count) so the hint survives.
|
|
69
72
|
const plainCapacity = Math.max(1, input.maxChars - charLength(header) - 2);
|
|
70
73
|
if (input.startIndex + plainCapacity >= total) {
|
|
71
|
-
const body =
|
|
74
|
+
const body = sliceChars(input.text, input.startIndex);
|
|
72
75
|
return { body, text: `${header}\n\n${body}`, truncated: false, nextIndex: input.startIndex };
|
|
73
76
|
}
|
|
74
77
|
|
|
75
78
|
const reserve = charLength(header) + 2 + charLength(truncationNote(total, total));
|
|
76
79
|
const capacity = Math.max(1, input.maxChars - reserve);
|
|
77
|
-
const
|
|
78
|
-
const
|
|
79
|
-
const nextIndex = input.startIndex + slicePoints.length;
|
|
80
|
+
const body = sliceChars(input.text, input.startIndex, input.startIndex + capacity);
|
|
81
|
+
const nextIndex = input.startIndex + charLength(body);
|
|
80
82
|
const text = `${header}\n\n${body}${truncationNote(nextIndex, total)}`;
|
|
81
83
|
|
|
82
84
|
return { body, text, truncated: true, nextIndex };
|
|
@@ -89,15 +91,21 @@ interface MatchFormatInput {
|
|
|
89
91
|
contentType: string;
|
|
90
92
|
matches: Passage[];
|
|
91
93
|
find: string[];
|
|
92
|
-
/**
|
|
93
|
-
|
|
94
|
+
/** Budget for the whole formatted result: header, passages, and note. */
|
|
95
|
+
maxChars: number;
|
|
96
|
+
/** True when the provider capped the list at `maxMatches`. */
|
|
97
|
+
cappedByMaxMatches: boolean;
|
|
94
98
|
}
|
|
95
99
|
|
|
96
100
|
interface FormattedMatches {
|
|
101
|
+
/** The passages that fit, rendered one per block. */
|
|
97
102
|
body: string;
|
|
103
|
+
/** Header, passages, and any truncation note. */
|
|
98
104
|
text: string;
|
|
99
|
-
/** True when the match
|
|
105
|
+
/** True when anything was hidden: the match cap, the budget, or an oversized passage. */
|
|
100
106
|
truncated: boolean;
|
|
107
|
+
/** The passages `body` and `text` actually contain. */
|
|
108
|
+
included: Passage[];
|
|
101
109
|
}
|
|
102
110
|
|
|
103
111
|
export function formatMatches(input: MatchFormatInput): FormattedMatches {
|
|
@@ -105,13 +113,51 @@ export function formatMatches(input: MatchFormatInput): FormattedMatches {
|
|
|
105
113
|
const header = `${pageHeader(input.title, input.finalUrl, input.status, input.contentType)}\nMatches for ${quoted}: ${input.matches.length}`;
|
|
106
114
|
|
|
107
115
|
if (input.matches.length === 0) {
|
|
108
|
-
return { body: "", text: `${header}\n\nNo matches.`, truncated: false };
|
|
116
|
+
return { body: "", text: `${header}\n\nNo matches.`, truncated: false, included: [] };
|
|
109
117
|
}
|
|
110
118
|
|
|
111
|
-
const
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
119
|
+
const blocks = input.matches.map((match, index) => `${index + 1}. [offset ${match.offset}] ${match.passage}`);
|
|
120
|
+
|
|
121
|
+
// Add whole blocks while they fit; the first one is kept even when oversized.
|
|
122
|
+
const shown: string[] = [];
|
|
123
|
+
let size = charLength(header) + 2;
|
|
124
|
+
for (const block of blocks) {
|
|
125
|
+
const length = charLength(block);
|
|
126
|
+
if (shown.length > 0 && size + length + 2 > input.maxChars) break;
|
|
127
|
+
shown.push(block);
|
|
128
|
+
size += length + 2;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
const noteFor = (count: number): string => {
|
|
132
|
+
if (count < blocks.length) {
|
|
133
|
+
return `(showing ${count} of ${blocks.length} matches within ${input.maxChars} characters; narrow find or lower contextChars)`;
|
|
134
|
+
}
|
|
135
|
+
if (input.cappedByMaxMatches) return `(first ${count} matches; raise maxMatches for more)`;
|
|
136
|
+
return "";
|
|
137
|
+
};
|
|
138
|
+
const render = (count: number, note: string): string => {
|
|
139
|
+
const base = `${header}\n\n${shown.slice(0, count).join("\n\n")}`;
|
|
140
|
+
return note ? `${base}\n\n${note}` : base;
|
|
141
|
+
};
|
|
142
|
+
|
|
143
|
+
// The note must survive the budget too, so drop trailing passages until it fits.
|
|
144
|
+
let count = shown.length;
|
|
145
|
+
let note = noteFor(count);
|
|
146
|
+
while (count > 1 && charLength(render(count, note)) > input.maxChars) {
|
|
147
|
+
count--;
|
|
148
|
+
note = noteFor(count);
|
|
149
|
+
}
|
|
150
|
+
if (note && charLength(render(count, note)) > input.maxChars) note = "";
|
|
151
|
+
|
|
152
|
+
let text = render(count, note);
|
|
153
|
+
const overflow = charLength(text) > input.maxChars;
|
|
154
|
+
if (overflow) text = truncateChars(text, input.maxChars);
|
|
155
|
+
|
|
156
|
+
const body = shown.slice(0, count).join("\n\n");
|
|
157
|
+
return {
|
|
158
|
+
body,
|
|
159
|
+
text,
|
|
160
|
+
truncated: count < blocks.length || input.cappedByMaxMatches || overflow,
|
|
161
|
+
included: input.matches.slice(0, count),
|
|
162
|
+
};
|
|
117
163
|
}
|
|
@@ -13,6 +13,7 @@ import type { WebFetchConfig } from "./config.ts";
|
|
|
13
13
|
import { extractReadable } from "./extract.ts";
|
|
14
14
|
import { extractPdfText, type PdfExtractor } from "./pdf.ts";
|
|
15
15
|
import { createFetchRunner, type HttpRunner, type HttpResponse } from "../http.ts";
|
|
16
|
+
import { decodeHtml } from "../charset.ts";
|
|
16
17
|
import { assertAllowedUrl } from "./ssrf.ts";
|
|
17
18
|
import type { FetchRequest } from "./types.ts";
|
|
18
19
|
|
|
@@ -149,7 +150,10 @@ export async function runFetch(
|
|
|
149
150
|
text = `(binary content: ${response.contentType || "application/pdf"}, ${response.sizeBytes} bytes; PDF text extraction failed: ${reason})`;
|
|
150
151
|
}
|
|
151
152
|
} else if (isHtmlType(response.contentType)) {
|
|
152
|
-
|
|
153
|
+
// `bytes` carries the raw body, so a page that declares GBK in a `<meta>` tag
|
|
154
|
+
// but not in the header is still decoded correctly.
|
|
155
|
+
const html = response.bytes ? decodeHtml(response.bytes, response.contentType) : response.body;
|
|
156
|
+
const page = extractReadable(html, response.finalUrl);
|
|
153
157
|
title = page.title;
|
|
154
158
|
text = page.text;
|
|
155
159
|
} else if (isTextualType(response.contentType)) {
|