assistsx-js 0.1.41 → 0.2.0

package/dist/Step.d.ts

@@ -1,355 +0,0 @@
-import { Node } from "./Node";
-import { StepError } from "./StepError";
-import { StepAsync } from "./StepAsync";
-export type StepResult = Step | undefined;
-export type StepImpl = (step: Step) => Promise<StepResult>;
-export type StepInterceptor = (step: Step) => StepResult | Promise<StepResult>;
-export declare class Step {
-    static delayMsDefault: number;
-    static readonly repeatCountInfinite: number;
-    static repeatCountMaxDefault: number;
-    static showLog: boolean;
-    static exceptionRetryCountMaxDefault: number;
-    /**
-     * 当前执行步骤的ID
-     */
-    private static _stepId;
-    /**
-     * 步骤拦截器列表
-     */
-    private static _interceptors;
-    /**
-     * 步骤异常变量，默认为空
-     */
-    static exception: StepError | undefined;
-    /**
-     * 运行步骤实现
-     * @param impl 步骤实现函数
-     * @param tag 步骤标签
-     * @param data 步骤数据
-     * @param delayMs 步骤延迟时间(毫秒)
-     */
-    static run(impl: StepImpl, { stepId, tag, data, delayMs, exceptionRetryCountMax, }?: {
-        stepId?: string | undefined;
-        tag?: string | undefined;
-        data?: any | undefined;
-        delayMs?: number;
-        exceptionRetryCountMax?: number;
-    }): Promise<Step | undefined>;
-    /**
-     * 获取当前步骤ID
-     */
-    static get stepId(): string | undefined;
-    /**
-     * 验证步骤ID是否匹配，如果不匹配则表示停止
-     * @param stepId 要验证的步骤ID
-     */
-    static assert(stepId: string | undefined): void;
-    /**
-     * 为节点数组分配步骤ID
-     * @param nodes 节点数组
-     * @param stepId 步骤ID
-     */
-    static assignIdsToNodes(nodes: Node[], stepId: string | undefined): void;
-    /**
-     * 停止当前步骤执行
-     * @param exception 可选的异常对象，如果传入则使用该异常，否则使用默认的StepStopError
-     */
-    static stop(exception?: StepError): void;
-    /**
-     * 添加步骤拦截器
-     * @param interceptor 拦截器函数
-     */
-    static addInterceptor(interceptor: StepInterceptor): void;
-    /**
-     * 移除步骤拦截器
-     * @param interceptor 要移除的拦截器函数
-     * @returns 是否成功删除
-     */
-    static removeInterceptor(interceptor: StepInterceptor): boolean;
-    /**
-     * 按索引移除步骤拦截器
-     * @param index 要移除的拦截器索引
-     * @returns 是否成功删除
-     */
-    static removeInterceptorByIndex(index: number): boolean;
-    /**
-     * 移除所有匹配的步骤拦截器
-     * @param interceptor 要移除的拦截器函数
-     * @returns 删除的拦截器数量
-     */
-    static removeAllInterceptors(interceptor: StepInterceptor): number;
-    /**
-     * 按条件移除步骤拦截器
-     * @param predicate 判断是否删除的条件函数
-     * @returns 删除的拦截器数量
-     */
-    static removeInterceptorByPredicate(predicate: (interceptor: StepInterceptor, index: number) => boolean): number;
-    /**
-     * 清空所有拦截器
-     */
-    static clearInterceptors(): void;
-    /**
-     * 获取所有拦截器
-     * @returns 拦截器数组
-     */
-    static getInterceptors(): StepInterceptor[];
-    /**
-     * 步骤ID
-     */
-    stepId: string;
-    /**
-     * 步骤重复执行次数
-     */
-    repeatCount: number;
-    /**
-     * 步骤重复执行最大次数,默认不限制
-     */
-    repeatCountMax: number;
-    /**
-     * 异常重试次数
-     */
-    exceptionRetryCount: number;
-    /**
-     * 异常重试最大次数,默认3次
-     */
-    exceptionRetryCountMax: number;
-    /**
-     * 步骤标签
-     */
-    tag: string | undefined;
-    isEnd: boolean;
-    /**
-     * 步骤数据
-     */
-    data: any | undefined;
-    /**
-     * 步骤延迟时间(毫秒)
-     */
-    delayMs: number;
-    /**
-     * 步骤实现函数
-     */
-    impl: StepImpl | undefined;
-    /**
-     * 构造函数
-     * @param stepId 步骤ID
-     * @param impl 步骤实现函数
-     * @param tag 步骤标签
-     * @param data 步骤数据
-     * @param delayMs 步骤延迟时间(毫秒)
-     */
-    constructor({ stepId, impl, tag, data, delayMs, repeatCountMax, exceptionRetryCountMax, isEnd, }: {
-        stepId: string;
-        impl: StepImpl | undefined;
-        tag?: string | undefined;
-        data?: any | undefined;
-        delayMs?: number;
-        repeatCountMax?: number;
-        exceptionRetryCountMax?: number;
-        isEnd?: boolean;
-    });
-    get async(): StepAsync;
-    /**
-     * 创建下一个步骤
-     * @param impl 下一步骤实现函数
-     * @param tag 步骤标签
-     * @param data 步骤数据
-     * @param delayMs 步骤延迟时间(毫秒)
-     * @returns 新的步骤实例
-     */
-    next(impl: StepImpl, { tag, data, delayMs, repeatCountMax, exceptionRetryCountMax, }?: {
-        tag?: string | undefined;
-        data?: any | undefined;
-        delayMs?: number;
-        repeatCountMax?: number;
-        exceptionRetryCountMax?: number;
-    }): Step;
-    end({ tag, data, delayMs, repeatCountMax, exceptionRetryCountMax, }?: {
-        tag?: string | undefined;
-        data?: any | undefined;
-        delayMs?: number;
-        repeatCountMax?: number;
-        exceptionRetryCountMax?: number;
-    }): Step;
-    /**
-     * 重复当前步骤
-     * @param stepId 步骤ID
-     * @param tag 步骤标签
-     * @param data 步骤数据
-     * @param delayMs 步骤延迟时间(毫秒)
-     * @returns 当前步骤实例
-     */
-    repeat({ stepId, tag, data, delayMs, repeatCountMax, exceptionRetryCountMax, }?: {
-        stepId?: string;
-        tag?: string | undefined;
-        data?: any | undefined;
-        delayMs?: number;
-        repeatCountMax?: number;
-        exceptionRetryCountMax?: number;
-    }): Step;
-    /**
-     * 延迟执行
-     * @param ms 延迟时间(毫秒)
-     * @returns Promise
-     */
-    delay(ms: number): Promise<void>;
-    /**
-     * 等待异步方法执行完成
-     * @param method 异步方法
-     * @returns Promise<T>
-     */
-    await<T>(method: () => Promise<T>): Promise<T>;
-    /**
-     * 对单个节点进行截图
-     * @param node 目标节点
-     * @param overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)
-     * @returns 截图路径
-     */
-    takeScreenshotByNode(node: Node, overlayHiddenScreenshotDelayMillis?: number): Promise<string>;
-    /**
-     * 对多个节点进行截图
-     * @param nodes 目标节点数组
-     * @param overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)
-     * @returns 截图路径数组
-     */
-    takeScreenshotNodes(nodes: Node[], overlayHiddenScreenshotDelayMillis?: number): Promise<string[]>;
-    /**
-     * 获取所有符合条件的节点
-     * @param filterClass 类名过滤
-     * @param filterViewId 视图ID过滤
-     * @param filterDes 描述过滤
-     * @param filterText 文本过滤
-     * @returns 节点数组
-     */
-    getAllNodes({ filterClass, filterViewId, filterDes, filterText, }?: {
-        filterClass?: string;
-        filterViewId?: string;
-        filterDes?: string;
-        filterText?: string;
-    }): Node[];
-    /**
-     * 启动应用
-     * @param packageName 应用包名
-     * @returns 是否启动成功
-     */
-    launchApp(packageName: string): boolean;
-    /**
-     * 获取当前应用包名
-     * @returns 包名
-     */
-    getPackageName(): string;
-    /**
-     * 通过ID查找节点
-     * @param id 节点ID
-     * @param filterClass 类名过滤
-     * @param filterText 文本过滤
-     * @param filterDes 描述过滤
-     * @returns 节点数组
-     */
-    findById(id: string, { filterClass, filterText, filterDes, }?: {
-        filterClass?: string;
-        filterText?: string;
-        filterDes?: string;
-    }): Node[];
-    /**
-     * 通过文本查找节点
-     * @param text 要查找的文本
-     * @param filterClass 类名过滤
-     * @param filterViewId 视图ID过滤
-     * @param filterDes 描述过滤
-     * @returns 节点数组
-     */
-    findByText(text: string, { filterClass, filterViewId, filterDes, }?: {
-        filterClass?: string;
-        filterViewId?: string;
-        filterDes?: string;
-    }): Node[];
-    /**
-     * 通过标签查找节点
-     * @param className 类名
-     * @param filterText 文本过滤
-     * @param filterViewId 视图ID过滤
-     * @param filterDes 描述过滤
-     * @returns 节点数组
-     */
-    findByTags(className: string, { filterText, filterViewId, filterDes, }?: {
-        filterText?: string;
-        filterViewId?: string;
-        filterDes?: string;
-    }): Node[];
-    /**
-     * 查找所有匹配文本的节点
-     * @param text 要查找的文本
-     * @returns 节点数组
-     */
-    findByTextAllMatch(text: string): Node[];
-    /**
-     * 检查是否包含指定文本
-     * @param text 要检查的文本
-     * @returns 是否包含
-     */
-    containsText(text: string): boolean;
-    /**
-     * 获取所有文本
-     * @returns 文本数组
-     */
-    getAllText(): string[];
-    /**
-     * 执行点击手势
-     * @param x 横坐标
-     * @param y 纵坐标
-     * @param duration 持续时间(毫秒)
-     * @returns 是否成功
-     */
-    clickByGesture(x: number, y: number, duration: number): Promise<boolean>;
-    longPressGestureAutoPaste(point: {
-        x: number;
-        y: number;
-    }, text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, }?: {
-        matchedPackageName?: string;
-        matchedText?: string;
-        timeoutMillis?: number;
-        longPressDuration?: number;
-    }): Promise<boolean>;
-    getAppInfo(packageName: string): Promise<any>;
-    performLinearGesture(startPoint: {
-        x: number;
-        y: number;
-    }, endPoint: {
-        x: number;
-        y: number;
-    }, { duration }?: {
-        duration?: number;
-    }): Promise<boolean>;
-    /**
-     * 返回操作
-     * @returns 是否成功
-     */
-    back(): boolean;
-    /**
-     * 回到主页
-     * @returns 是否成功
-     */
-    home(): boolean;
-    /**
-     * 打开通知栏
-     * @returns 是否成功
-     */
-    notifications(): boolean;
-    /**
-     * 显示最近应用
-     * @returns 是否成功
-     */
-    recentApps(): boolean;
-    /**
-     * 获取屏幕尺寸
-     * @returns 屏幕尺寸对象
-     */
-    getScreenSize(): any;
-    /**
-     * 获取应用窗口尺寸
-     * @returns 应用窗口尺寸对象
-     */
-    getAppScreenSize(): any;
-}