@dyyz1993/xpage API 概览

@dyyz1993/xpage 是基于 Playwright 的浏览器自动化引擎库。

核心导出

命令执行

import {
  executePageCommand,
  getCommandHandler,
  hasCommand,
  executeCommandChain,
} from '@dyyz1993/xpage';

函数	用途
executePageCommand(page, name, args)	执行单个页面命令
getCommandHandler(name)	获取命令处理函数
hasCommand(name)	检查命令是否存在
executeCommandChain(page, input, options?)	执行命令链

命令定义与解析

import {
  commands,
  getCommandNames,
  parseArgsToRecord,
  parseCommandChain,
} from '@dyyz1993/xpage';

录制与回放

import { RecorderController, PlaybackEngine } from '@dyyz1993/xpage';

会话管理

import {
  ensureStorage,
  getSessionPath,
  loadSessionInfo,
  saveSessionInfo,
  deleteSessionInfo,
  listSessions,
} from '@dyyz1993/xpage';

页面命令一览

导航

goto goBack goForward reload title url

交互

click fill type press hover scroll select check dblclick

查询

query find html text textContent inputValue getAttribute

等待

waitForSelector wait

截图

screenshot screenshotBase64

结构与无障碍

structure a11y snapshot

执行

evaluate evaluateRaw

类型

interface CommandResult<T = unknown> {
  success: boolean;
  data: T;
  message?: string;
  tips: string[];
  meta?: {
    duration?: number;
    command?: string;
    site?: string;
  };
}

interface ChainExecutionResult {
  success: boolean;
  steps: StepResult[];
  totalDuration: number;
}

interface RecordedEvent {
  id: string;
  type: EventType;
  timestamp: number;
  selector?: string;
  xpath?: string;
  tagName?: string;
  text?: string;
  data: EventData;
  waitBefore?: WaitCondition[];
  assertAfter?: AssertCondition[];
  pageState?: PageState;
}

interface RecordingSession {
  id: string;
  name?: string;
  startTime: number;
  endTime?: number;
  duration: number;
  startUrl: string;
  viewport: { width: number; height: number };
  events: RecordedEvent[];
  metadata: RecordingMetadata;
}

下一步

• 命令执行 — 详细的命令执行 API
• 录制器 — RecorderController API
• 回放引擎 — PlaybackEngine API
• 全部命令 — 完整命令参考