all repos — sz-chrome-remote-cdp @ master

pi-browser-harness, patched to drive a Chrome on another host over CDP, with castle_cdp_search web search

src/domains/form.ts (view raw)

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
import { Type } from "typebox";
import { type Result, err, ok } from "../util/result";
import { defineBrowserTool, type ToolErr, type ToolOk } from "../util/tool";
import { detailsOf, isPageResult, type PageResult, resolveAndCall, runOnElement } from "./element-call";
import { fillBody } from "./fill-engine";
import { interactiveDiff } from "./ref-resolve";

const FillArgs = Type.Object({
  ref: Type.Optional(
    Type.String({
      description:
        "Stable element ref from browser_snapshot (e.g. 'e7'). PREFERRED over selector — survives re-renders. When set, selector is ignored.",
    }),
  ),
  selector: Type.Optional(Type.String({ description: "CSS selector of the form field to fill (fallback when no ref)" })),
  value: Type.String({ description: "Value to set in the field" }),
});

const FILL_BODY = `const value = arg;\n${fillBody({ rejectSelect: true, focusFirst: false })}`;

const NOT_FOUND: PageResult = { ok: false, reason: "not_found" };

export const fillTool = defineBrowserTool({
  name: "browser_fill",
  label: "Browser Fill",
  description:
    "Fill a form field (input/textarea/contenteditable), or tick a checkbox/radio by passing 'true'/'false'. PREFERRED: pass `ref` (e.g. 'e7') from browser_snapshot — survives re-renders. Fallback: a CSS `selector`. Writes through the native value setter and fires bubbling 'input'/'change' events, so React/Vue/Angular controlled components and rich-text editors update correctly — unlike browser_type. Refuses a disabled field rather than writing a value the page will ignore. Returns the field's value after writing, plus a compact diff of page changes.",
  promptSnippet: "Fill a form field by ref (preferred) or selector (works with React/Vue controlled inputs)",
  promptGuidelines: [
    "Pass the desired value; no browser_click is needed first.",
    "For a checkbox or radio pass 'true' or 'false' — it toggles `checked`, not the submit value. browser_set_checked does the same thing with a boolean.",
    "Use browser_type instead only for keystroke-sensitive widgets (autocomplete, masked/segmented inputs).",
    "Fill sets the value but does not focus or submit. To submit a tag/autocomplete input, follow with browser_dispatch_key({ ref, key: 'Enter' }) — not browser_press_key, which targets the focused element and may miss this field.",
    "For a custom (div-based) dropdown, browser_fill won't validate against its option list — open it, run browser_snapshot, then browser_click the option's ref.",
    "Confirm the field value browser_fill returns matches what you intended.",
  ],
  parameters: FillArgs,
  concurrency: "serialized",
  async handler(args, { client }): Promise<Result<ToolOk, ToolErr>> {
    const r = await runOnElement(client, {
      ref: args.ref,
      selector: args.selector,
      fnBody: FILL_BODY,
      arg: args.value,
      notFound: NOT_FOUND,
    });
    if (!r.success) return r;
    const res = isPageResult(r.data) ? r.data : undefined;
    const target = args.ref ?? args.selector ?? "";
    if (res === undefined || res.reason === "not_found") {
      return err({
        kind: "invalid_state",
        message: `No element matched: ${target}`,
        details: { ref: args.ref, selector: args.selector },
      });
    }
    if (!res.ok) {
      const details = { ref: args.ref, selector: args.selector, ...(res.tag !== undefined ? { tag: res.tag } : {}) };
      if (res.kind === "select") {
        return err({
          kind: "invalid_state",
          message: `Element <select> is not fillable (not an input, textarea, or contenteditable): ${target}. For <select> use browser_select_option.`,
          details,
        });
      }
      return err({
        kind: "invalid_state",
        message: `Could not fill ${target}: ${res.reason ?? "unknown reason"}`,
        details,
      });
    }
    const shown = res.value !== undefined ? JSON.stringify(res.value) : `checked=${res.checked === true}`;
    const diff = await interactiveDiff(client);
    return ok({
      text: `Filled ${target} = ${shown}${diff}`,
      details: {
        ref: args.ref,
        selector: args.selector,
        value: args.value,
        verified: res.value ?? res.checked,
        ...(res.tag !== undefined ? { tag: res.tag } : {}),
        ...(res.kind !== undefined ? { kind: res.kind } : {}),
      },
    });
  },
});

const FocusArgs = Type.Object({
  ref: Type.Optional(
    Type.String({ description: "Stable element ref from browser_snapshot (e.g. 'e7'). PREFERRED over selector." }),
  ),
  selector: Type.Optional(Type.String({ description: "CSS selector of the element to focus (fallback when no ref)" })),
});

type FocusResult = { status: "ok"; tag: string } | { status: "not_found" } | { status: "not_focusable"; tag: string };

const isFocusResult = (v: unknown): v is FocusResult => {
  if (typeof v !== "object" || v === null || !("status" in v)) return false;
  if (v.status === "not_found") return true;
  if (v.status === "ok" || v.status === "not_focusable") return "tag" in v && typeof v.tag === "string";
  return false;
};

const FOCUS_FN = `
  const el = this;
  if (typeof el.focus !== "function") return { status: "not_focusable", tag: el.tagName };
  el.focus();
  return document.activeElement === el ? { status: "ok", tag: el.tagName } : { status: "not_focusable", tag: el.tagName };
`;

export const focusTool = defineBrowserTool({
  name: "browser_focus",
  label: "Browser Focus",
  description:
    "Focus an element via the DOM .focus() method — deterministic, no coordinate accuracy needed. PREFERRED: pass `ref` from browser_snapshot; fallback: a CSS `selector`. Use before browser_type when a click might miss the field.",
  promptSnippet: "Focus an element by ref (preferred) or selector",
  promptGuidelines: [
    "For simply setting a value, prefer browser_fill (it doesn't need a separate focus step).",
  ],
  parameters: FocusArgs,
  concurrency: "serialized",
  async handler(args, { client }): Promise<Result<ToolOk, ToolErr>> {
    const r = await runOnElement(client, { ref: args.ref, selector: args.selector, fnBody: FOCUS_FN, arg: "" });
    if (!r.success) return r;
    const res = isFocusResult(r.data) ? r.data : undefined;
    const target = args.ref ?? args.selector ?? "";
    if (res === undefined || res.status === "not_found") {
      return err({ kind: "invalid_state", message: `No element matched: ${target}`, details: { ref: args.ref, selector: args.selector } });
    }
    if (res.status === "not_focusable") {
      return err({ kind: "invalid_state", message: `Element <${res.tag.toLowerCase()}> could not be focused: ${target}`, details: { ref: args.ref, selector: args.selector, tag: res.tag } });
    }
    return ok({ text: `Focused ${target}`, details: { ref: args.ref, selector: args.selector, tag: res.tag } });
  },
});

const SelectOptionArgs = Type.Object({
  ref: Type.Optional(
    Type.String({ description: "Stable element ref of the <select> from browser_snapshot. PREFERRED over selector." }),
  ),
  selector: Type.Optional(Type.String({ description: "CSS selector of the <select> element (fallback when no ref)" })),
  value: Type.Optional(Type.String({ description: "Option value attribute to select" })),
  label: Type.Optional(Type.String({ description: "Visible option text to select (exact match)" })),
  index: Type.Optional(Type.Integer({ minimum: 0, description: "Zero-based option index to select" })),
});

type SelectResult =
  | { status: "ok"; value: string; label: string }
  | { status: "not_found" }
  | { status: "not_select"; tag: string }
  | { status: "no_match"; options: ReadonlyArray<{ value: string; label: string }> };

const isSelectOption = (v: unknown): v is { value: string; label: string } =>
  typeof v === "object" && v !== null
  && "value" in v && typeof v.value === "string"
  && "label" in v && typeof v.label === "string";

const isSelectResult = (v: unknown): v is SelectResult => {
  if (typeof v !== "object" || v === null || !("status" in v)) return false;
  if (v.status === "not_found") return true;
  if (v.status === "not_select") return "tag" in v && typeof v.tag === "string";
  if (v.status === "ok") {
    return "value" in v && typeof v.value === "string" && "label" in v && typeof v.label === "string";
  }
  if (v.status === "no_match") {
    return "options" in v && Array.isArray(v.options) && v.options.every(isSelectOption);
  }
  return false;
};

const SELECT_FN = `
  const el = this;
  if (el.tagName !== "SELECT") return { status: "not_select", tag: el.tagName };
  const opts = Array.from(el.options);
  const wv = arg.wv, wl = arg.wl, wi = arg.wi;
  let opt = null;
  if (wi !== null) opt = opts[wi] || null;
  else if (wv !== null) opt = opts.find(o => o.value === wv) || null;
  else if (wl !== null) opt = opts.find(o => o.text === wl) || null;
  if (!opt) return { status: "no_match", options: opts.map(o => ({ value: o.value, label: o.text })) };
  el.value = opt.value;
  el.dispatchEvent(new Event("input", { bubbles: true }));
  el.dispatchEvent(new Event("change", { bubbles: true }));
  return { status: "ok", value: opt.value, label: opt.text };
`;

export const selectOptionTool = defineBrowserTool({
  name: "browser_select_option",
  label: "Browser Select Option",
  description:
    "Select an option in a native <select> element by value, visible label, or index. PREFERRED: pass `ref` from browser_snapshot; fallback: a CSS `selector`. Sets the selection and fires bubbling 'input'/'change' events so framework listeners update. On no match, returns the available options.",
  promptSnippet: "Select an option in a native <select> by ref (preferred) or selector",
  promptGuidelines: [
    "Provide exactly one of value, label, or index to choose the option.",
    "For custom (non-native) dropdowns built from divs, click to open then browser_click the option instead.",
  ],
  parameters: SelectOptionArgs,
  concurrency: "serialized",
  async handler(args, { client }): Promise<Result<ToolOk, ToolErr>> {
    if (args.value === undefined && args.label === undefined && args.index === undefined) {
      return err({ kind: "invalid_state", message: "Provide one of value, label, or index." });
    }
    // null sentinels distinguish "not provided" from a real empty-string match.
    const arg = { wv: args.value ?? null, wl: args.label ?? null, wi: args.index ?? null };
    const r = await runOnElement(client, { ref: args.ref, selector: args.selector, fnBody: SELECT_FN, arg });
    if (!r.success) return r;
    const res = isSelectResult(r.data) ? r.data : undefined;
    const target = args.ref ?? args.selector ?? "";
    if (res === undefined || res.status === "not_found") {
      return err({ kind: "invalid_state", message: `No element matched: ${target}`, details: { ref: args.ref, selector: args.selector } });
    }
    if (res.status === "not_select") {
      return err({ kind: "invalid_state", message: `Element <${res.tag.toLowerCase()}> is not a <select>: ${target}`, details: { ref: args.ref, selector: args.selector, tag: res.tag } });
    }
    if (res.status === "no_match") {
      return err({
        kind: "invalid_state",
        message: `No matching option in ${target}. Available: ${res.options.map((o) => o.label).join(", ")}`,
        details: { ref: args.ref, selector: args.selector, options: res.options },
      });
    }
    const diff = await interactiveDiff(client);
    return ok({
      text: `Selected "${res.label}" (value=${JSON.stringify(res.value)}) in ${target}${diff}`,
      details: { ref: args.ref, selector: args.selector, value: res.value, label: res.label },
    });
  },
});

const CHECK_FN = `
function(checked) {
  const el = this;
  const tag = (el.tagName || "").toLowerCase();
  const type = (el.type || "").toLowerCase();
  if (tag !== "input" || (type !== "checkbox" && type !== "radio")) return { ok: false, reason: "ref is not a checkbox or radio" };
  if (el.disabled) return { ok: false, reason: "element is disabled" };
  const want = checked === true;
  let changed = false;
  if (el.checked !== want) {
    try { el.click(); } catch (e) {}
    if (el.checked !== want) { el.checked = want; el.dispatchEvent(new Event("change", { bubbles: true })); }
    changed = true;
  }
  return { ok: true, checked: el.checked, changed: changed };
}`;

const SetCheckedArgs = Type.Object({
  ref: Type.String({ description: "Stable element ref of a checkbox or radio from browser_snapshot (e.g. 'e7')." }),
  checked: Type.Boolean({ description: "Desired checked state." }),
});

export const setCheckedTool = defineBrowserTool({
  name: "browser_set_checked",
  label: "Browser Set Checked",
  description:
    "Set a checkbox or radio to a desired checked state by ref. Only acts if the current state differs, fires change, and reports the final state. Get the ref from browser_snapshot's [eN].",
  promptSnippet: "Set a checkbox/radio checked state by ref",
  promptGuidelines: [
    "For radios, set checked:true on the option you want; the group deselects the others.",
  ],
  parameters: SetCheckedArgs,
  concurrency: "serialized",
  async handler(args, { client }): Promise<Result<ToolOk, ToolErr>> {
    const r = await resolveAndCall(client, args.ref, CHECK_FN, [args.checked]);
    if (!r.success) return r;
    const res = r.data;
    if (!res.ok) {
      return err({ kind: "invalid_state", message: `Could not set checked on ref ${args.ref}: ${res.reason ?? "unknown reason"}`, details: detailsOf(args.ref, res) });
    }
    return ok({
      text: `Set ref ${args.ref} checked=${res.checked}` + (res.changed === false ? " (already)" : ""),
      details: detailsOf(args.ref, res),
    });
  },
});