assistsx-js 0.0.1353 → 0.0.2002

package/dist/Step.d.ts

@@ -1,4 +1,7 @@
-import { Node } from './Node';
+import { Node } from "./Node";
+import { StepAsync } from "./StepAsync";
+export type StepResult = Step | undefined;
+export type StepImpl = (step: Step) => Promise<StepResult>;
 export declare class Step {
     static delayMsDefault: number;
     static readonly repeatCountInfinite: number;
@@ -15,17 +18,17 @@ export declare class Step {
      * @param data 步骤数据
      * @param delayMs 步骤延迟时间(毫秒)
      */
-    static run(impl: (step: Step) => Promise<Step | undefined>, { tag, data, delayMs }?: {
+    static run(impl: StepImpl, { tag, data, delayMs, }?: {
         tag?: string | undefined;
         data?: any | undefined;
         delayMs?: number;
-    }): Promise<void>;
+    }): Promise<Step>;
     /**
      * 获取当前步骤ID
      */
     static get stepId(): string | undefined;
     /**
-     * 验证步骤ID是否匹配
+     * 验证步骤ID是否匹配，如果不匹配则表示停止
      * @param stepId 要验证的步骤ID
      */
     static assert(stepId: string | undefined): void;
@@ -66,7 +69,7 @@ export declare class Step {
     /**
      * 步骤实现函数
      */
-    impl: (step: Step) => Promise<Step | undefined>;
+    impl: StepImpl;
     /**
      * 构造函数
      * @param stepId 步骤ID
@@ -75,14 +78,15 @@ export declare class Step {
      * @param data 步骤数据
      * @param delayMs 步骤延迟时间(毫秒)
      */
-    constructor({ stepId, impl, tag, data, delayMs, repeatCountMax }: {
+    constructor({ stepId, impl, tag, data, delayMs, repeatCountMax, }: {
         stepId: string;
-        impl: (step: Step) => Promise<Step | undefined>;
+        impl: StepImpl;
         tag?: string | undefined;
         data?: any | undefined;
         delayMs?: number;
         repeatCountMax?: number;
     });
+    get async(): StepAsync;
     /**
      * 创建下一个步骤
      * @param impl 下一步骤实现函数
@@ -91,7 +95,7 @@ export declare class Step {
      * @param delayMs 步骤延迟时间(毫秒)
      * @returns 新的步骤实例
      */
-    next(impl: (step: Step) => Promise<Step | undefined>, { tag, data, delayMs, repeatCountMax }?: {
+    next(impl: StepImpl, { tag, data, delayMs, repeatCountMax, }?: {
         tag?: string | undefined;
         data?: any | undefined;
         delayMs?: number;
@@ -105,7 +109,7 @@ export declare class Step {
      * @param delayMs 步骤延迟时间(毫秒)
      * @returns 当前步骤实例
      */
-    repeat({ stepId, tag, data, delayMs, repeatCountMax }?: {
+    repeat({ stepId, tag, data, delayMs, repeatCountMax, }?: {
         stepId?: string;
         tag?: string | undefined;
         data?: any | undefined;
@@ -146,7 +150,7 @@ export declare class Step {
      * @param filterText 文本过滤
      * @returns 节点数组
      */
-    getAllNodes({ filterClass, filterViewId, filterDes, filterText }?: {
+    getAllNodes({ filterClass, filterViewId, filterDes, filterText, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
@@ -171,7 +175,7 @@ export declare class Step {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findById(id: string, { filterClass, filterText, filterDes }?: {
+    findById(id: string, { filterClass, filterText, filterDes, }?: {
         filterClass?: string;
         filterText?: string;
         filterDes?: string;
@@ -184,7 +188,7 @@ export declare class Step {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByText(text: string, { filterClass, filterViewId, filterDes }?: {
+    findByText(text: string, { filterClass, filterViewId, filterDes, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
@@ -197,7 +201,7 @@ export declare class Step {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByTags(className: string, { filterText, filterViewId, filterDes }?: {
+    findByTags(className: string, { filterText, filterViewId, filterDes, }?: {
         filterText?: string;
         filterViewId?: string;
         filterDes?: string;
@@ -219,12 +223,6 @@ export declare class Step {
      * @returns 文本数组
      */
     getAllText(): string[];
-    /**
-     * 查找第一个匹配标签的父节点
-     * @param className 类名
-     * @returns 父节点
-     */
-    findFirstParentByTags(className: string): Node;
     /**
      * 执行点击手势
      * @param x 横坐标
@@ -236,7 +234,7 @@ export declare class Step {
     longPressGestureAutoPaste(point: {
         x: number;
         y: number;
-    }, text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration }?: {
+    }, text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, }?: {
         matchedPackageName?: string;
         matchedText?: string;
         timeoutMillis?: number;

package/dist/Step.js

@@ -3,8 +3,10 @@
  * 用于管理和执行自动化步骤，提供步骤的生命周期管理、状态控制和界面操作功能
  */
 import { AssistsX } from "./AssistsX";
-import { useStepStore } from './StepStateStore';
+import { useStepStore } from "./StepStateStore";
 import { generateUUID } from "./Utils";
+import { StepError } from "./StepError";
+import { StepAsync } from "./StepAsync";
 export class Step {
     /**
      * 运行步骤实现
@@ -13,38 +15,47 @@ export class Step {
      * @param data 步骤数据
      * @param delayMs 步骤延迟时间(毫秒)
      */
-    static async run(impl, { tag, data, delayMs = Step.delayMsDefault } = {}) {
+    static async run(impl, { tag, data, delayMs = Step.delayMsDefault, } = {}) {
         var _a;
         const stepStore = useStepStore();
         let implnName = impl.name;
+        let currentStep;
+        let nextStep;
         try {
             //步骤开始
             this._stepId = generateUUID();
             stepStore.startStep(this._stepId, tag, data);
-            let step = new Step({ stepId: this._stepId, impl, tag, data, delayMs });
+            currentStep = new Step({
+                stepId: this._stepId,
+                impl,
+                tag,
+                data,
+                delayMs,
+            });
             while (true) {
-                if (step.delayMs) {
+                if (currentStep.delayMs) {
                     if (Step.showLog) {
-                        console.log(`延迟${step.delayMs}毫秒`);
+                        console.log(`延迟${currentStep.delayMs}毫秒`);
                     }
-                    await step.delay(step.delayMs);
-                    Step.assert(step.stepId);
+                    await currentStep.delay(currentStep.delayMs);
+                    Step.assert(currentStep.stepId);
                 }
                 //执行步骤
-                implnName = step.impl.name;
+                implnName = currentStep.impl.name;
                 if (Step.showLog) {
-                    console.log(`执行步骤${implnName}，重复次数${step.repeatCount}`);
+                    console.log(`执行步骤${implnName}，重复次数${currentStep.repeatCount}`);
                 }
-                const nextStep = await step.impl(step);
-                if (step.repeatCountMax > Step.repeatCountInfinite && step.repeatCount > step.repeatCountMax) {
+                nextStep = await currentStep.impl(currentStep);
+                if (currentStep.repeatCountMax > Step.repeatCountInfinite &&
+                    currentStep.repeatCount > currentStep.repeatCountMax) {
                     if (Step.showLog) {
-                        console.log(`重复次数${step.repeatCount}超过最大次数${step.repeatCountMax}，停止执行`);
+                        console.log(`重复次数${currentStep.repeatCount}超过最大次数${currentStep.repeatCountMax}，停止执行`);
                     }
                     break;
                 }
-                Step.assert(step.stepId);
+                Step.assert(currentStep.stepId);
                 if (nextStep) {
-                    step = nextStep;
+                    currentStep = nextStep;
                 }
                 else {
                     break;
@@ -60,13 +71,14 @@ export class Step {
                 impl: implnName,
                 tag: tag,
                 data: data,
-                error: (_a = e === null || e === void 0 ? void 0 : e.message) !== null && _a !== void 0 ? _a : String(e)
+                error: (_a = e === null || e === void 0 ? void 0 : e.message) !== null && _a !== void 0 ? _a : String(e),
             });
             stepStore.setError(errorMsg);
-            throw new Error(errorMsg);
+            throw new StepError(errorMsg, implnName, tag, data, e, currentStep || undefined);
         }
         //步骤执行结束
         stepStore.completeStep();
+        return currentStep;
     }
     /**
      * 获取当前步骤ID
@@ -75,7 +87,7 @@ export class Step {
         return this._stepId;
     }
     /**
-     * 验证步骤ID是否匹配
+     * 验证步骤ID是否匹配，如果不匹配则表示停止
      * @param stepId 要验证的步骤ID
      */
     static assert(stepId) {
@@ -90,7 +102,7 @@ export class Step {
      */
     static assignIdsToNodes(nodes, stepId) {
         if (stepId) {
-            nodes.forEach(node => {
+            nodes.forEach((node) => {
                 node.stepId = stepId;
             });
         }
@@ -109,7 +121,7 @@ export class Step {
      * @param data 步骤数据
      * @param delayMs 步骤延迟时间(毫秒)
      */
-    constructor({ stepId, impl, tag, data, delayMs = Step.delayMsDefault, repeatCountMax = Step.repeatCountMaxDefault }) {
+    constructor({ stepId, impl, tag, data, delayMs = Step.delayMsDefault, repeatCountMax = Step.repeatCountMaxDefault, }) {
         /**
          * 步骤ID
          */
@@ -133,6 +145,9 @@ export class Step {
         this.delayMs = delayMs;
         this.repeatCountMax = repeatCountMax;
     }
+    get async() {
+        return new StepAsync(this);
+    }
     /**
      * 创建下一个步骤
      * @param impl 下一步骤实现函数
@@ -141,9 +156,16 @@ export class Step {
      * @param delayMs 步骤延迟时间(毫秒)
      * @returns 新的步骤实例
      */
-    next(impl, { tag, data, delayMs = Step.delayMsDefault, repeatCountMax = Step.repeatCountMaxDefault } = {}) {
-        Step.assert(this.stepId);
-        return new Step({ stepId: this.stepId, impl, tag, data: data !== null && data !== void 0 ? data : this.data, delayMs, repeatCountMax });
+    next(impl, { tag, data, delayMs = Step.delayMsDefault, repeatCountMax = Step.repeatCountMaxDefault, } = {}) {
+        Step.assert(this.stepId);
+        return new Step({
+            stepId: this.stepId,
+            impl,
+            tag,
+            data: data !== null && data !== void 0 ? data : this.data,
+            delayMs,
+            repeatCountMax,
+        });
     }
     /**
      * 重复当前步骤
@@ -153,7 +175,7 @@ export class Step {
      * @param delayMs 步骤延迟时间(毫秒)
      * @returns 当前步骤实例
      */
-    repeat({ stepId = this.stepId, tag = this.tag, data = this.data, delayMs = this.delayMs, repeatCountMax = this.repeatCountMax } = {}) {
+    repeat({ stepId = this.stepId, tag = this.tag, data = this.data, delayMs = this.delayMs, repeatCountMax = this.repeatCountMax, } = {}) {
         Step.assert(this.stepId);
         this.repeatCount++;
         this.stepId = stepId;
@@ -225,9 +247,14 @@ export class Step {
      * @param filterText 文本过滤
      * @returns 节点数组
      */
-    getAllNodes({ filterClass, filterViewId, filterDes, filterText } = {}) {
+    getAllNodes({ filterClass, filterViewId, filterDes, filterText, } = {}) {
         Step.assert(this.stepId);
-        const nodes = AssistsX.getAllNodes({ filterClass, filterViewId, filterDes, filterText });
+        const nodes = AssistsX.getAllNodes({
+            filterClass,
+            filterViewId,
+            filterDes,
+            filterText,
+        });
         Step.assert(this.stepId);
         Step.assignIdsToNodes(nodes, this.stepId);
         return nodes;
@@ -261,7 +288,7 @@ export class Step {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findById(id, { filterClass, filterText, filterDes } = {}) {
+    findById(id, { filterClass, filterText, filterDes, } = {}) {
         Step.assert(this.stepId);
         const nodes = AssistsX.findById(id, { filterClass, filterText, filterDes });
         Step.assert(this.stepId);
@@ -276,9 +303,13 @@ export class Step {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByText(text, { filterClass, filterViewId, filterDes } = {}) {
+    findByText(text, { filterClass, filterViewId, filterDes, } = {}) {
         Step.assert(this.stepId);
-        const nodes = AssistsX.findByText(text, { filterClass, filterViewId, filterDes });
+        const nodes = AssistsX.findByText(text, {
+            filterClass,
+            filterViewId,
+            filterDes,
+        });
         Step.assert(this.stepId);
         Step.assignIdsToNodes(nodes, this.stepId);
         return nodes;
@@ -291,9 +322,13 @@ export class Step {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByTags(className, { filterText, filterViewId, filterDes } = {}) {
+    findByTags(className, { filterText, filterViewId, filterDes, } = {}) {
         Step.assert(this.stepId);
-        const nodes = AssistsX.findByTags(className, { filterText, filterViewId, filterDes });
+        const nodes = AssistsX.findByTags(className, {
+            filterText,
+            filterViewId,
+            filterDes,
+        });
         Step.assert(this.stepId);
         Step.assignIdsToNodes(nodes, this.stepId);
         return nodes;
@@ -331,17 +366,6 @@ export class Step {
         Step.assert(this.stepId);
         return texts;
     }
-    /**
-     * 查找第一个匹配标签的父节点
-     * @param className 类名
-     * @returns 父节点
-     */
-    findFirstParentByTags(className) {
-        Step.assert(this.stepId);
-        const node = AssistsX.findFirstParentByTags(className);
-        Step.assert(this.stepId);
-        return node;
-    }
     /**
      * 执行点击手势
      * @param x 横坐标
@@ -355,9 +379,14 @@ export class Step {
         Step.assert(this.stepId);
         return result;
     }
-    async longPressGestureAutoPaste(point, text, { matchedPackageName, matchedText, timeoutMillis, longPressDuration } = { matchedText: "粘贴", timeoutMillis: 1500, longPressDuration: 600 }) {
+    async longPressGestureAutoPaste(point, text, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, } = { matchedText: "粘贴", timeoutMillis: 1500, longPressDuration: 600 }) {
         Step.assert(this.stepId);
-        const result = await AssistsX.longPressGestureAutoPaste(point, text, { matchedPackageName, matchedText, timeoutMillis, longPressDuration });
+        const result = await AssistsX.longPressGestureAutoPaste(point, text, {
+            matchedPackageName,
+            matchedText,
+            timeoutMillis,
+            longPressDuration,
+        });
         Step.assert(this.stepId);
         return result;
     }
@@ -369,7 +398,9 @@ export class Step {
     }
     async performLinearGesture(startPoint, endPoint, { duration } = {}) {
         Step.assert(this.stepId);
-        const result = await AssistsX.performLinearGesture(startPoint, endPoint, { duration });
+        const result = await AssistsX.performLinearGesture(startPoint, endPoint, {
+            duration,
+        });
         Step.assert(this.stepId);
         return result;
     }

package/dist/StepAsync.d.ts

@@ -0,0 +1,162 @@
+import { Node } from "./Node";
+import { Step } from "./Step";
+export declare class StepAsync {
+    private step;
+    /**
+     * 构造函数
+     * @param step Step实例
+     */
+    constructor(step: Step);
+    /**
+     * 对单个节点进行截图
+     * @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;
+    }): Promise<Node[]>;
+    /**
+     * 启动应用
+     * @param packageName 应用包名
+     * @returns 是否启动成功
+     */
+    launchApp(packageName: string): Promise<boolean>;
+    /**
+     * 获取当前应用包名
+     * @returns 包名
+     */
+    getPackageName(): Promise<string>;
+    /**
+     * 通过ID查找节点
+     * @param id 节点ID
+     * @param filterClass 类名过滤
+     * @param filterText 文本过滤
+     * @param filterDes 描述过滤
+     * @returns 节点数组
+     */
+    findById(id: string, { filterClass, filterText, filterDes, }?: {
+        filterClass?: string;
+        filterText?: string;
+        filterDes?: string;
+    }): Promise<Node[]>;
+    /**
+     * 通过文本查找节点
+     * @param text 要查找的文本
+     * @param filterClass 类名过滤
+     * @param filterViewId 视图ID过滤
+     * @param filterDes 描述过滤
+     * @returns 节点数组
+     */
+    findByText(text: string, { filterClass, filterViewId, filterDes, }?: {
+        filterClass?: string;
+        filterViewId?: string;
+        filterDes?: string;
+    }): Promise<Node[]>;
+    /**
+     * 通过标签查找节点
+     * @param className 类名
+     * @param filterText 文本过滤
+     * @param filterViewId 视图ID过滤
+     * @param filterDes 描述过滤
+     * @returns 节点数组
+     */
+    findByTags(className: string, { filterText, filterViewId, filterDes, }?: {
+        filterText?: string;
+        filterViewId?: string;
+        filterDes?: string;
+    }): Promise<Node[]>;
+    /**
+     * 查找所有匹配文本的节点
+     * @param text 要查找的文本
+     * @returns 节点数组
+     */
+    findByTextAllMatch(text: string): Promise<Node[]>;
+    /**
+     * 检查是否包含指定文本
+     * @param text 要检查的文本
+     * @returns 是否包含
+     */
+    containsText(text: string): Promise<boolean>;
+    /**
+     * 获取所有文本
+     * @returns 文本数组
+     */
+    getAllText(): Promise<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(): Promise<boolean>;
+    /**
+     * 回到主页
+     * @returns 是否成功
+     */
+    home(): Promise<boolean>;
+    /**
+     * 打开通知栏
+     * @returns 是否成功
+     */
+    notifications(): Promise<boolean>;
+    /**
+     * 显示最近应用
+     * @returns 是否成功
+     */
+    recentApps(): Promise<boolean>;
+    /**
+     * 获取屏幕尺寸
+     * @returns 屏幕尺寸对象
+     */
+    getScreenSize(): Promise<any>;
+    /**
+     * 获取应用窗口尺寸
+     * @returns 应用窗口尺寸对象
+     */
+    getAppScreenSize(): Promise<any>;
+}