assistsx-js 0.0.1353 → 0.0.2002

package/dist/Node.js

@@ -1,5 +1,6 @@
-import { AssistsX } from './AssistsX';
-import { Step } from './Step';
+import { AssistsX } from "./AssistsX";
+import { Step } from "./Step";
+import { NodeAsync } from "./NodeAsync";
 // 将接口改造为类
 export class Node {
     /**
@@ -17,6 +18,20 @@ export class Node {
         this.isEnabled = params.isEnabled;
         this.stepId = params.stepId;
     }
+    get async() {
+        return new NodeAsync(this);
+    }
+    /**
+     * 查找第一个匹配标签的父节点
+     * @param className 类名
+     * @returns 父节点
+     */
+    findFirstParentByTags(className) {
+        Step.assert(this.stepId);
+        const node = AssistsX.findFirstParentByTags(this, className);
+        Step.assert(this.stepId);
+        return node;
+    }
     /**
      * 对节点执行点击手势
      * @param offsetX X轴偏移
@@ -25,9 +40,14 @@ export class Node {
      * @param clickDuration 点击持续时间
      * @returns 是否点击成功
      */
-    async clickNodeByGesture({ offsetX, offsetY, switchWindowIntervalDelay, clickDuration } = {}) {
+    async clickNodeByGesture({ offsetX, offsetY, switchWindowIntervalDelay, clickDuration, } = {}) {
         Step.assert(this.stepId);
-        const result = await AssistsX.clickNodeByGesture(this, { offsetX, offsetY, switchWindowIntervalDelay, clickDuration });
+        const result = await AssistsX.clickNodeByGesture(this, {
+            offsetX,
+            offsetY,
+            switchWindowIntervalDelay,
+            clickDuration,
+        });
         Step.assert(this.stepId);
         return result;
     }
@@ -40,15 +60,26 @@ export class Node {
      * @param clickInterval 点击间隔
      * @returns 是否双击成功
      */
-    async doubleClickNodeByGesture({ offsetX, offsetY, switchWindowIntervalDelay, clickDuration, clickInterval } = {}) {
+    async doubleClickNodeByGesture({ offsetX, offsetY, switchWindowIntervalDelay, clickDuration, clickInterval, } = {}) {
         Step.assert(this.stepId);
-        const result = await AssistsX.doubleClickNodeByGesture(this, { offsetX, offsetY, switchWindowIntervalDelay, clickDuration, clickInterval });
+        const result = await AssistsX.doubleClickNodeByGesture(this, {
+            offsetX,
+            offsetY,
+            switchWindowIntervalDelay,
+            clickDuration,
+            clickInterval,
+        });
         Step.assert(this.stepId);
         return result;
     }
-    async longPressNodeByGestureAutoPaste(text, { matchedPackageName, matchedText, timeoutMillis, longPressDuration } = { matchedText: "粘贴", timeoutMillis: 1500, longPressDuration: 600 }) {
+    async longPressNodeByGestureAutoPaste(text, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, } = { matchedText: "粘贴", timeoutMillis: 1500, longPressDuration: 600 }) {
         Step.assert(this.stepId);
-        const result = await AssistsX.longPressNodeByGestureAutoPaste(this, text, { matchedPackageName, matchedText, timeoutMillis, longPressDuration });
+        const result = await AssistsX.longPressNodeByGestureAutoPaste(this, text, {
+            matchedPackageName,
+            matchedText,
+            timeoutMillis,
+            longPressDuration,
+        });
         Step.assert(this.stepId);
         return result;
     }
@@ -60,9 +91,14 @@ export class Node {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByTags(className, { filterText, filterViewId, filterDes } = {}) {
-        Step.assert(this.stepId);
-        const result = AssistsX.findByTags(className, { filterText, filterViewId, filterDes, node: this });
+    findByTags(className, { filterText, filterViewId, filterDes, } = {}) {
+        Step.assert(this.stepId);
+        const result = AssistsX.findByTags(className, {
+            filterText,
+            filterViewId,
+            filterDes,
+            node: this,
+        });
         Step.assignIdsToNodes(result, this.stepId);
         Step.assert(this.stepId);
         return result;
@@ -75,9 +111,14 @@ export class Node {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findById(id, { filterClass, filterText, filterDes } = {}) {
-        Step.assert(this.stepId);
-        const result = AssistsX.findById(id, { filterClass, filterText, filterDes, node: this });
+    findById(id, { filterClass, filterText, filterDes, } = {}) {
+        Step.assert(this.stepId);
+        const result = AssistsX.findById(id, {
+            filterClass,
+            filterText,
+            filterDes,
+            node: this,
+        });
         Step.assignIdsToNodes(result, this.stepId);
         Step.assert(this.stepId);
         return result;
@@ -90,9 +131,14 @@ export class Node {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByText(text, { filterClass, filterViewId, filterDes } = {}) {
-        Step.assert(this.stepId);
-        const result = AssistsX.findByText(text, { filterClass, filterViewId, filterDes, node: this });
+    findByText(text, { filterClass, filterViewId, filterDes, } = {}) {
+        Step.assert(this.stepId);
+        const result = AssistsX.findByText(text, {
+            filterClass,
+            filterViewId,
+            filterDes,
+            node: this,
+        });
         Step.assignIdsToNodes(result, this.stepId);
         Step.assert(this.stepId);
         return result;
@@ -123,9 +169,12 @@ export class Node {
      * @param isFullyByCompareNode 是否完全可见
      * @returns 是否可见
      */
-    isVisible({ compareNode, isFullyByCompareNode } = {}) {
+    isVisible({ compareNode, isFullyByCompareNode, } = {}) {
         Step.assert(this.stepId);
-        const response = AssistsX.isVisible(this, { compareNode, isFullyByCompareNode });
+        const response = AssistsX.isVisible(this, {
+            compareNode,
+            isFullyByCompareNode,
+        });
         Step.assert(this.stepId);
         return response;
     }
@@ -157,6 +206,12 @@ export class Node {
         Step.assert(this.stepId);
         return result;
     }
+    focus() {
+        Step.assert(this.stepId);
+        const result = AssistsX.focus(this);
+        Step.assert(this.stepId);
+        return result;
+    }
     /**
      * 点击节点
      * @returns 是否点击成功
@@ -260,6 +315,6 @@ export class Node {
      * @returns 节点数组
      */
     static fromJSONArray(array) {
-        return array.map(data => new Node(data));
+        return array.map((data) => new Node(data));
     }
 }

package/dist/NodeAsync.d.ts

@@ -0,0 +1,200 @@
+/**
+ * 节点类
+ * 表示界面上的一个可交互元素，包含元素的属性和可执行的操作
+ */
+import { Bounds } from "./Bounds";
+import { Node } from "./Node";
+export declare class NodeAsync {
+    private node;
+    /**
+     * 构造函数
+     * @param node Node实例
+     */
+    constructor(node: Node);
+    /**
+     * 查找第一个匹配标签的父节点
+     * @param className 类名
+     * @returns 父节点
+     */
+    findFirstParentByTags(className: string): Promise<Node>;
+    /**
+     * 对节点执行点击手势
+     * @param offsetX X轴偏移
+     * @param offsetY Y轴偏移
+     * @param switchWindowIntervalDelay 窗口切换延迟
+     * @param clickDuration 点击持续时间
+     * @returns 是否点击成功
+     */
+    clickNodeByGesture({ offsetX, offsetY, switchWindowIntervalDelay, clickDuration, }?: {
+        offsetX?: number;
+        offsetY?: number;
+        switchWindowIntervalDelay?: number;
+        clickDuration?: number;
+    }): Promise<boolean>;
+    /**
+     * 对节点执行双击手势
+     * @param offsetX X轴偏移
+     * @param offsetY Y轴偏移
+     * @param switchWindowIntervalDelay 窗口切换延迟
+     * @param clickDuration 点击持续时间
+     * @param clickInterval 点击间隔
+     * @returns 是否双击成功
+     */
+    doubleClickNodeByGesture({ offsetX, offsetY, switchWindowIntervalDelay, clickDuration, clickInterval, }?: {
+        offsetX?: number;
+        offsetY?: number;
+        switchWindowIntervalDelay?: number;
+        clickDuration?: number;
+        clickInterval?: number;
+    }): Promise<boolean>;
+    longPressNodeByGestureAutoPaste(text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, }?: {
+        matchedPackageName?: string;
+        matchedText?: string;
+        timeoutMillis?: number;
+        longPressDuration?: number;
+    }): Promise<boolean>;
+    /**
+     * 在当前节点范围内通过标签查找节点
+     * @param className 类名
+     * @param filterText 文本过滤
+     * @param filterViewId 视图ID过滤
+     * @param filterDes 描述过滤
+     * @returns 节点数组
+     */
+    findByTags(className: string, { filterText, filterViewId, filterDes, }?: {
+        filterText?: string;
+        filterViewId?: string;
+        filterDes?: string;
+    }): Promise<Node[]>;
+    /**
+     * 在当前节点范围内通过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[]>;
+    /**
+     * 向前滚动节点
+     * @returns 是否滚动成功
+     */
+    scrollForward(): Promise<boolean>;
+    /**
+     * 向后滚动节点
+     * @returns 是否滚动成功
+     */
+    scrollBackward(): Promise<boolean>;
+    /**
+     * 检查节点是否可见
+     * @param compareNode 比较节点
+     * @param isFullyByCompareNode 是否完全可见
+     * @returns 是否可见
+     */
+    isVisible({ compareNode, isFullyByCompareNode, }?: {
+        compareNode?: Node;
+        isFullyByCompareNode?: boolean;
+    }): Promise<boolean>;
+    /**
+     * 对节点进行截图
+     * @param overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)
+     * @returns 截图路径
+     */
+    takeScreenshot(overlayHiddenScreenshotDelayMillis?: number): Promise<string>;
+    /**
+     * 设置节点文本
+     * @param text 要设置的文本
+     * @returns 是否设置成功
+     */
+    setNodeText(text: string): Promise<boolean>;
+    paste(text: string): Promise<boolean>;
+    focus(): Promise<boolean>;
+    /**
+     * 点击节点
+     * @returns 是否点击成功
+     */
+    click(): Promise<boolean>;
+    /**
+     * 长按节点
+     * @returns 是否长按成功
+     */
+    longClick(): Promise<boolean>;
+    /**
+     * 查找第一个可点击的父节点
+     * @returns 可点击的父节点
+     */
+    findFirstParentClickable(): Promise<Node>;
+    /**
+     * 获取节点在屏幕中的边界
+     * @returns 边界对象
+     */
+    getBoundsInScreen(): Promise<Bounds>;
+    /**
+     * 获取节点的所有子节点
+     * @returns 子节点数组
+     */
+    getNodes(): Promise<Node[]>;
+    /**
+     * 获取节点的直接子节点
+     * @returns 子节点数组
+     */
+    getChildren(): Promise<Node[]>;
+    /**
+     * 从JSON字符串创建节点实例
+     * @param json JSON字符串
+     * @returns 节点实例
+     */
+    static fromJSON(json: string): Node;
+    /**
+     * 从普通对象创建节点实例
+     * @param data 对象数据
+     * @returns 节点实例
+     */
+    static from(data: any): Node;
+    /**
+     * JSON.parse的reviver函数，用于将解析的JSON对象转换为Node实例
+     * @param key 属性键
+     * @param value 属性值
+     * @returns 转换后的值
+     */
+    static reviver(key: string, value: any): any;
+    /**
+     * 创建新的节点实例
+     * @param params 节点参数对象
+     * @returns 节点实例
+     */
+    static create(params: {
+        nodeId: string;
+        text: string;
+        des: string;
+        viewId: string;
+        className: string;
+        isScrollable: boolean;
+        isClickable: boolean;
+        isEnabled: boolean;
+        stepId: string | undefined;
+    }): Node;
+    /**
+     * 从JSON数组创建节点数组
+     * @param array JSON数组
+     * @returns 节点数组
+     */
+    static fromJSONArray(array: Array<any>): Node[];
+}

package/dist/NodeAsync.js

@@ -0,0 +1,308 @@
+import { Step } from "./Step";
+import { AssistsXAsync } from "./AssistsXAsync";
+import { Node } from "./Node";
+export class NodeAsync {
+    /**
+     * 构造函数
+     * @param node Node实例
+     */
+    constructor(node) {
+        this.node = node;
+    }
+    /**
+     * 查找第一个匹配标签的父节点
+     * @param className 类名
+     * @returns 父节点
+     */
+    async findFirstParentByTags(className) {
+        Step.assert(this.node.stepId);
+        const node = await AssistsXAsync.findFirstParentByTags(this.node, className);
+        Step.assert(this.node.stepId);
+        return node;
+    }
+    /**
+     * 对节点执行点击手势
+     * @param offsetX X轴偏移
+     * @param offsetY Y轴偏移
+     * @param switchWindowIntervalDelay 窗口切换延迟
+     * @param clickDuration 点击持续时间
+     * @returns 是否点击成功
+     */
+    async clickNodeByGesture({ offsetX, offsetY, switchWindowIntervalDelay, clickDuration, } = {}) {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.clickNodeByGesture(this.node, {
+            offsetX,
+            offsetY,
+            switchWindowIntervalDelay,
+            clickDuration,
+        });
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    /**
+     * 对节点执行双击手势
+     * @param offsetX X轴偏移
+     * @param offsetY Y轴偏移
+     * @param switchWindowIntervalDelay 窗口切换延迟
+     * @param clickDuration 点击持续时间
+     * @param clickInterval 点击间隔
+     * @returns 是否双击成功
+     */
+    async doubleClickNodeByGesture({ offsetX, offsetY, switchWindowIntervalDelay, clickDuration, clickInterval, } = {}) {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.doubleClickNodeByGesture(this.node, {
+            offsetX,
+            offsetY,
+            switchWindowIntervalDelay,
+            clickDuration,
+            clickInterval,
+        });
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    async longPressNodeByGestureAutoPaste(text, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, } = { matchedText: "粘贴", timeoutMillis: 1500, longPressDuration: 600 }) {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.longPressNodeByGestureAutoPaste(this.node, text, {
+            matchedPackageName,
+            matchedText,
+            timeoutMillis,
+            longPressDuration,
+        });
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    /**
+     * 在当前节点范围内通过标签查找节点
+     * @param className 类名
+     * @param filterText 文本过滤
+     * @param filterViewId 视图ID过滤
+     * @param filterDes 描述过滤
+     * @returns 节点数组
+     */
+    async findByTags(className, { filterText, filterViewId, filterDes, } = {}) {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.findByTags(className, {
+            filterText,
+            filterViewId,
+            filterDes,
+            node: this.node,
+        });
+        Step.assignIdsToNodes(result, this.node.stepId);
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    /**
+     * 在当前节点范围内通过ID查找节点
+     * @param id 节点ID
+     * @param filterClass 类名过滤
+     * @param filterText 文本过滤
+     * @param filterDes 描述过滤
+     * @returns 节点数组
+     */
+    async findById(id, { filterClass, filterText, filterDes, } = {}) {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.findById(id, {
+            filterClass,
+            filterText,
+            filterDes,
+            node: this.node,
+        });
+        Step.assignIdsToNodes(result, this.node.stepId);
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    /**
+     * 在当前节点范围内通过文本查找节点
+     * @param text 要查找的文本
+     * @param filterClass 类名过滤
+     * @param filterViewId 视图ID过滤
+     * @param filterDes 描述过滤
+     * @returns 节点数组
+     */
+    async findByText(text, { filterClass, filterViewId, filterDes, } = {}) {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.findByText(text, {
+            filterClass,
+            filterViewId,
+            filterDes,
+            node: this.node,
+        });
+        Step.assignIdsToNodes(result, this.node.stepId);
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    /**
+     * 向前滚动节点
+     * @returns 是否滚动成功
+     */
+    async scrollForward() {
+        Step.assert(this.node.stepId);
+        const response = await AssistsXAsync.scrollForward(this.node);
+        Step.assert(this.node.stepId);
+        return response;
+    }
+    /**
+     * 向后滚动节点
+     * @returns 是否滚动成功
+     */
+    async scrollBackward() {
+        Step.assert(this.node.stepId);
+        const response = await AssistsXAsync.scrollBackward(this.node);
+        Step.assert(this.node.stepId);
+        return response;
+    }
+    /**
+     * 检查节点是否可见
+     * @param compareNode 比较节点
+     * @param isFullyByCompareNode 是否完全可见
+     * @returns 是否可见
+     */
+    async isVisible({ compareNode, isFullyByCompareNode, } = {}) {
+        Step.assert(this.node.stepId);
+        const response = await AssistsXAsync.isVisible(this.node, {
+            compareNode,
+            isFullyByCompareNode,
+        });
+        Step.assert(this.node.stepId);
+        return response;
+    }
+    /**
+     * 对节点进行截图
+     * @param overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)
+     * @returns 截图路径
+     */
+    async takeScreenshot(overlayHiddenScreenshotDelayMillis = 250) {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.takeScreenshotNodes([this.node], overlayHiddenScreenshotDelayMillis);
+        Step.assert(this.node.stepId);
+        return result[0];
+    }
+    /**
+     * 设置节点文本
+     * @param text 要设置的文本
+     * @returns 是否设置成功
+     */
+    async setNodeText(text) {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.setNodeText(this.node, text);
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    async paste(text) {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.paste(this.node, text);
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    async focus() {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.focus(this.node);
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    /**
+     * 点击节点
+     * @returns 是否点击成功
+     */
+    async click() {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.click(this.node);
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    /**
+     * 长按节点
+     * @returns 是否长按成功
+     */
+    async longClick() {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.longClick(this.node);
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    /**
+     * 查找第一个可点击的父节点
+     * @returns 可点击的父节点
+     */
+    async findFirstParentClickable() {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.findFirstParentClickable(this.node);
+        Step.assert(this.node.stepId);
+        Step.assignIdsToNodes([result], this.node.stepId);
+        return result;
+    }
+    /**
+     * 获取节点在屏幕中的边界
+     * @returns 边界对象
+     */
+    async getBoundsInScreen() {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.getBoundsInScreen(this.node);
+        Step.assert(this.node.stepId);
+        return result;
+    }
+    /**
+     * 获取节点的所有子节点
+     * @returns 子节点数组
+     */
+    async getNodes() {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.getNodes(this.node);
+        Step.assert(this.node.stepId);
+        Step.assignIdsToNodes(result, this.node.stepId);
+        return result;
+    }
+    /**
+     * 获取节点的直接子节点
+     * @returns 子节点数组
+     */
+    async getChildren() {
+        Step.assert(this.node.stepId);
+        const result = await AssistsXAsync.getChildren(this.node);
+        Step.assert(this.node.stepId);
+        Step.assignIdsToNodes(result, this.node.stepId);
+        return result;
+    }
+    /**
+     * 从JSON字符串创建节点实例
+     * @param json JSON字符串
+     * @returns 节点实例
+     */
+    static fromJSON(json) {
+        const data = JSON.parse(json);
+        return new Node(data);
+    }
+    /**
+     * 从普通对象创建节点实例
+     * @param data 对象数据
+     * @returns 节点实例
+     */
+    static from(data) {
+        return new Node(data);
+    }
+    /**
+     * JSON.parse的reviver函数，用于将解析的JSON对象转换为Node实例
+     * @param key 属性键
+     * @param value 属性值
+     * @returns 转换后的值
+     */
+    static reviver(key, value) {
+        return key === "" ? new Node(value) : value;
+    }
+    /**
+     * 创建新的节点实例
+     * @param params 节点参数对象
+     * @returns 节点实例
+     */
+    static create(params) {
+        return new Node(params);
+    }
+    /**
+     * 从JSON数组创建节点数组
+     * @param array JSON数组
+     * @returns 节点数组
+     */
+    static fromJSONArray(array) {
+        return array.map((data) => new Node(data));
+    }
+}