assistsx-js 0.1.41 → 0.2.0

package/dist/AssistsXAsync.d.ts

@@ -1,532 +0,0 @@
-/**
- * AssistsX 类
- * 提供与移动应用程序界面交互的工具类，包括节点查找、手势操作、屏幕操作等功能
- */
-import { Node } from "./Node";
-import { Bounds } from "./Bounds";
-import { AppInfo } from "./AppInfo";
-import { DeviceInfo } from "./DeviceInfo";
-import { WebFloatingWindowOptions } from "./AssistsX";
-/**
- * 截图识别位置信息
- */
-export interface RecognizeTextInScreenshotPosition {
-    text: string;
-    left: number;
-    top: number;
-    right: number;
-    bottom: number;
-    width: number;
-    height: number;
-}
-/**
- * 截图识别结果
- */
-export interface RecognizeTextInScreenshotResult {
-    fullText: string;
-    processingTimeMillis: number;
-    positions: RecognizeTextInScreenshotPosition[];
-}
-/**
- * 截图识别区域参数
- */
-export interface RecognizeTextRegion {
-    left?: number;
-    top?: number;
-    right?: number;
-    bottom?: number;
-    width?: number;
-    height?: number;
-}
-/**
- * 联系人信息
- */
-export interface Contact {
-    id: string;
-    name: string;
-    phoneNumbers: string[];
-    emails: string[];
-    address: string;
-}
-export declare class AssistsXAsync {
-    /**
-     * 执行异步调用
-     * @param method 方法名
-     * @param args 参数对象
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns Promise<调用响应>
-     */
-    private static asyncCall;
-    /**
-     * 设置悬浮窗标志
-     * @param flags 标志
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否设置成功
-     */
-    static setOverlayFlags(flags: number, timeout?: number): Promise<boolean>;
-    /**
-     * 设置悬浮窗标志
-     * @param flags 标志
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否设置成功
-     */
-    static setOverlayFlagList(flags: number[], timeout?: number): Promise<boolean>;
-    /**
-     * 获取所有符合条件的节点
-     * @param filterClass 类名过滤
-     * @param filterViewId 视图ID过滤
-     * @param filterDes 描述过滤
-     * @param filterText 文本过滤
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 节点数组
-     */
-    static getAllNodes({ filterClass, filterViewId, filterDes, filterText, timeout, }?: {
-        filterClass?: string;
-        filterViewId?: string;
-        filterDes?: string;
-        filterText?: string;
-        timeout?: number;
-    }): Promise<Node[]>;
-    /**
-     * 设置节点文本
-     * @param node 目标节点
-     * @param text 要设置的文本
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否设置成功
-     */
-    static setNodeText(node: Node, text: string, timeout?: number): Promise<boolean>;
-    /**
-     * 对指定节点进行截图
-     * @param nodes 要截图的节点数组
-     * @param overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 截图路径数组
-     */
-    static takeScreenshotNodes(nodes: Node[], overlayHiddenScreenshotDelayMillis?: number, timeout?: number): Promise<string[]>;
-    /**
-     * 保存全屏截图到文件
-     * @param options 截图保存选项
-     * @param options.filePath 文件路径（可选，不提供则自动生成）
-     * @param options.format 图片格式，支持 "PNG"、"JPEG"、"JPG"、"WEBP"，默认为 "PNG"
-     * @param options.overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)，默认为 250
-     * @param options.timeout 超时时间(秒)，默认30秒
-     * @returns 保存的文件路径
-     */
-    static takeScreenshotSave(options?: {
-        filePath?: string;
-        format?: "PNG" | "JPEG" | "JPG" | "WEBP";
-        overlayHiddenScreenshotDelayMillis?: number;
-        timeout?: number;
-    }): Promise<string>;
-    /**
-     * 保存截图到文件（支持多个节点）
-     * @param options 截图保存选项
-     * @param options.nodes 要截图的节点数组（可选，不提供则保存全屏截图）
-     * @param options.filePath 文件路径（可选，不提供则自动生成。多个节点时会自动添加索引后缀）
-     * @param options.format 图片格式，支持 "PNG"、"JPEG"、"JPG"、"WEBP"，默认为 "PNG"
-     * @param options.overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)，默认为 250
-     * @param options.timeout 超时时间(秒)，默认30秒
-     * @returns 保存的文件路径数组
-     */
-    static takeScreenshotToFile(options?: {
-        nodes?: Node[];
-        filePath?: string;
-        format?: "PNG" | "JPEG" | "JPG" | "WEBP";
-        overlayHiddenScreenshotDelayMillis?: number;
-        timeout?: number;
-    }): Promise<string[]>;
-    /**
-     * 截图识别文本
-     * @param param0 识别参数
-     * @returns 截图识别结果
-     */
-    static recognizeTextInScreenshot(targetText: string, options?: {
-        rotationDegrees?: number;
-        overlayHiddenScreenshotDelayMillis?: number;
-        restoreOverlay?: boolean;
-        region?: RecognizeTextRegion;
-        timeout?: number;
-    }): Promise<RecognizeTextInScreenshotResult>;
-    static scanQR(timeout?: number): Promise<string>;
-    static loadWebViewOverlay(url: string, options?: WebFloatingWindowOptions & {
-        timeout?: number;
-    }): Promise<any>;
-    /**
-     * 关闭当前 WebView 悬浮窗
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否关闭成功（当前页面在悬浮窗内时返回 true，否则 false）
-     */
-    static closeOverlay(timeout?: number): Promise<boolean>;
-    /**
-     * 点击节点
-     * @param node 要点击的节点
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否点击成功
-     */
-    static click(node: Node, timeout?: number): Promise<boolean>;
-    /**
-     * 长按节点
-     * @param node 要长按的节点
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否长按成功
-     */
-    static longClick(node: Node, timeout?: number): Promise<boolean>;
-    /**
-     * 启动应用
-     * @param packageName 应用包名
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否启动成功
-     */
-    static launchApp(packageName: string, timeout?: number): Promise<boolean>;
-    /**
-     * 获取当前应用包名
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 包名
-     */
-    static getPackageName(timeout?: number): Promise<string>;
-    /**
-     * 显示悬浮提示
-     * @param text 提示文本
-     * @param delay 显示时长(毫秒)
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否显示成功
-     */
-    static overlayToast(text: string, delay?: number, timeout?: number): Promise<boolean>;
-    /**
-     * 通过ID查找节点
-     * @param id 节点ID
-     * @param filterClass 类名过滤
-     * @param filterText 文本过滤
-     * @param filterDes 描述过滤
-     * @param node 父节点范围
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 节点数组
-     */
-    static findById(id: string, { filterClass, filterText, filterDes, node, timeout, }?: {
-        filterClass?: string;
-        filterText?: string;
-        filterDes?: string;
-        node?: Node;
-        timeout?: number;
-    }): Promise<Node[]>;
-    /**
-     * 通过文本查找节点
-     * @param text 要查找的文本
-     * @param filterClass 类名过滤
-     * @param filterViewId 视图ID过滤
-     * @param filterDes 描述过滤
-     * @param node 父节点范围
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 节点数组
-     */
-    static findByText(text: string, { filterClass, filterViewId, filterDes, node, timeout, }?: {
-        filterClass?: string;
-        filterViewId?: string;
-        filterDes?: string;
-        node?: Node;
-        timeout?: number;
-    }): Promise<Node[]>;
-    /**
-     * 通过标签查找节点
-     * @param className 类名
-     * @param filterText 文本过滤
-     * @param filterViewId 视图ID过滤
-     * @param filterDes 描述过滤
-     * @param node 父节点范围
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 节点数组
-     */
-    static findByTags(className: string, { filterText, filterViewId, filterDes, node, timeout, }?: {
-        filterText?: string;
-        filterViewId?: string;
-        filterDes?: string;
-        node?: Node;
-        timeout?: number;
-    }): Promise<Node[]>;
-    /**
-     * 查找所有匹配文本的节点
-     * @param text 要查找的文本
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 节点数组
-     */
-    static findByTextAllMatch(text: string, timeout?: number): Promise<Node[]>;
-    /**
-     * 检查是否包含指定文本
-     * @param text 要检查的文本
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否包含
-     */
-    static containsText(text: string, timeout?: number): Promise<boolean>;
-    /**
-     * 获取所有文本
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 文本数组
-     */
-    static getAllText(timeout?: number): Promise<string[]>;
-    /**
-     * 查找第一个匹配标签的父节点
-     * @param className 类名
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 父节点
-     */
-    static findFirstParentByTags(node: Node, className: string, timeout?: number): Promise<Node>;
-    /**
-     * 获取节点的所有子节点
-     * @param node 父节点
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 子节点数组
-     */
-    static getNodes(node: Node, timeout?: number): Promise<Node[]>;
-    /**
-     * 获取节点的直接子节点
-     * @param node 父节点
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 子节点数组
-     */
-    static getChildren(node: Node, timeout?: number): Promise<Node[]>;
-    /**
-     * 查找第一个可点击的父节点
-     * @param node 起始节点
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 可点击的父节点
-     */
-    static findFirstParentClickable(node: Node, timeout?: number): Promise<Node>;
-    /**
-     * 获取节点在屏幕中的边界
-     * @param node 目标节点
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 边界对象
-     */
-    static getBoundsInScreen(node: Node, timeout?: number): Promise<Bounds>;
-    /**
-     * 检查节点是否可见
-     * @param node 目标节点
-     * @param compareNode 比较节点
-     * @param isFullyByCompareNode 是否完全可见
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否可见
-     */
-    static isVisible(node: Node, { compareNode, isFullyByCompareNode, timeout, }?: {
-        compareNode?: Node;
-        isFullyByCompareNode?: boolean;
-        timeout?: number;
-    }): Promise<boolean>;
-    /**
-     * 执行点击手势
-     * @param x 横坐标
-     * @param y 纵坐标
-     * @param duration 持续时间
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static clickByGesture(x: number, y: number, duration: number, timeout?: number): Promise<boolean>;
-    /**
-     * 返回操作
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static back(timeout?: number): Promise<boolean>;
-    /**
-     * 回到主页
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static home(timeout?: number): Promise<boolean>;
-    /**
-     * 打开通知栏
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static notifications(timeout?: number): Promise<boolean>;
-    /**
-     * 显示最近应用
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static recentApps(timeout?: number): Promise<boolean>;
-    /**
-     * 在节点中粘贴文本
-     * @param node 目标节点
-     * @param text 要粘贴的文本
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static paste(node: Node, text: string, timeout?: number): Promise<boolean>;
-    static focus(node: Node, timeout?: number): Promise<boolean>;
-    /**
-     * 选择文本
-     * @param node 目标节点
-     * @param selectionStart 选择起始位置
-     * @param selectionEnd 选择结束位置
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static selectionText(node: Node, selectionStart: number, selectionEnd: number, timeout?: number): Promise<boolean>;
-    /**
-     * 向前滚动
-     * @param node 可滚动节点
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static scrollForward(node: Node, timeout?: number): Promise<boolean>;
-    /**
-     * 向后滚动
-     * @param node 可滚动节点
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static scrollBackward(node: Node, timeout?: number): Promise<boolean>;
-    /**
-     * 对节点执行点击手势
-     * @param node 目标节点
-     * @param offsetX X轴偏移
-     * @param offsetY Y轴偏移
-     * @param switchWindowIntervalDelay 窗口切换延迟
-     * @param clickDuration 点击持续时间
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static clickNodeByGesture(node: Node, { offsetX, offsetY, switchWindowIntervalDelay, clickDuration, timeout, }?: {
-        offsetX?: number;
-        offsetY?: number;
-        switchWindowIntervalDelay?: number;
-        clickDuration?: number;
-        timeout?: number;
-    }): Promise<boolean>;
-    /**
-     * 对节点执行双击手势
-     * @param node 目标节点
-     * @param offsetX X轴偏移
-     * @param offsetY Y轴偏移
-     * @param switchWindowIntervalDelay 窗口切换延迟
-     * @param clickDuration 点击持续时间
-     * @param clickInterval 点击间隔
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功
-     */
-    static doubleClickNodeByGesture(node: Node, { offsetX, offsetY, switchWindowIntervalDelay, clickDuration, clickInterval, timeout, }?: {
-        offsetX?: number;
-        offsetY?: number;
-        switchWindowIntervalDelay?: number;
-        clickDuration?: number;
-        clickInterval?: number;
-        timeout?: number;
-    }): Promise<boolean>;
-    /**
-     * 执行线型手势
-     * @param startPoint
-     * @param endPoint
-     * @param param2
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns
-     */
-    static performLinearGesture(startPoint: {
-        x: number;
-        y: number;
-    }, endPoint: {
-        x: number;
-        y: number;
-    }, { duration, timeout }?: {
-        duration?: number;
-        timeout?: number;
-    }): Promise<boolean>;
-    static longPressNodeByGestureAutoPaste(node: Node, text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, timeout, }?: {
-        matchedPackageName?: string;
-        matchedText?: string;
-        timeoutMillis?: number;
-        longPressDuration?: number;
-        timeout?: number;
-    }): Promise<boolean>;
-    static longPressGestureAutoPaste(point: {
-        x: number;
-        y: number;
-    }, text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, timeout, }?: {
-        matchedPackageName?: string;
-        matchedText?: string;
-        timeoutMillis?: number;
-        longPressDuration?: number;
-        timeout?: number;
-    }): Promise<boolean>;
-    static getAppInfo(packageName: string, timeout?: number): Promise<AppInfo>;
-    static getUniqueDeviceId(timeout?: number): Promise<any>;
-    static getAndroidID(timeout?: number): Promise<any>;
-    static getMacAddress(timeout?: number): Promise<any>;
-    static getDeviceInfo(timeout?: number): Promise<DeviceInfo>;
-    /**
-     * 获取屏幕尺寸
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 屏幕尺寸对象
-     */
-    static getScreenSize(timeout?: number): Promise<any>;
-    /**
-     * 获取应用窗口尺寸
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 应用窗口尺寸对象
-     */
-    static getAppScreenSize(timeout?: number): Promise<any>;
-    /**
-     * 在浏览器中打开URL
-     * @param url 要打开的URL
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否成功打开
-     */
-    static openUrlInBrowser(url: string, timeout?: number): Promise<boolean>;
-    static download(url: string, timeout?: number): Promise<string | null | undefined>;
-    static audioPlayFromFile(filePath: string, { volume, useAbsoluteVolume, timeout, }: {
-        volume?: number;
-        useAbsoluteVolume?: boolean;
-        timeout?: number;
-    }): Promise<string | null | undefined>;
-    static audioStop({ timeout, }: {
-        timeout?: number;
-    }): Promise<boolean | null | undefined>;
-    /**
-     * 播放系统电话铃声
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 播放结果消息
-     */
-    static audioPlayRingtone({ timeout, }: {
-        timeout?: number;
-    }): Promise<string>;
-    /**
-     * 停止播放系统电话铃声
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 停止结果消息
-     */
-    static audioStopRingtone({ timeout, }: {
-        timeout?: number;
-    }): Promise<string>;
-    /**
-     * 添加联系人
-     * @param name 联系人姓名（必填）
-     * @param phoneNumber 电话号码（必填）
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 是否添加成功
-     */
-    static addContact(name: string, phoneNumber: string, timeout?: number): Promise<boolean>;
-    /**
-     * 获取所有联系人
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 联系人列表
-     */
-    static getAllContacts(timeout?: number): Promise<Contact[]>;
-    /**
-     * 保存根节点树为JSON文件
-     * @param options 保存选项
-     * @param options.filePath 文件路径（可选，不提供则自动生成）
-     * @param options.prettyPrint 是否格式化输出，默认为 true
-     * @param options.timeout 超时时间(秒)，默认30秒
-     * @returns 保存的文件路径
-     */
-    static saveRootNodeTreeJson(options?: {
-        filePath?: string;
-        prettyPrint?: boolean;
-        timeout?: number;
-    }): Promise<string>;
-    /**
-     * 获取剪贴板文本内容
-     * @param timeout 超时时间(秒)，默认30秒
-     * @returns 剪贴板文本内容，如果获取失败则返回空字符串
-     */
-    static getClipboardText(timeout?: number): Promise<string>;
-}