assistsx-js 0.0.1353 → 0.0.2002

package/src/StepAsync.ts

@@ -0,0 +1,365 @@
+/**
+ * 步骤执行控制类
+ * 用于管理和执行自动化步骤，提供步骤的生命周期管理、状态控制和界面操作功能
+ */
+import { AssistsX } from "./AssistsX";
+import { Node } from "./Node";
+import { CallMethod } from "./CallMethod";
+import { useStepStore } from "./StepStateStore";
+import { generateUUID } from "./Utils";
+import { StepError } from "./StepError";
+import { AssistsXAsync } from "./AssistsXAsync";
+import { Step } from "./Step";
+
+export class StepAsync {
+  private step: Step;
+
+  /**
+   * 构造函数
+   * @param step Step实例
+   */
+  constructor(step: Step) {
+    this.step = step;
+  }
+
+  /**
+   * 对单个节点进行截图
+   * @param node 目标节点
+   * @param overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)
+   * @returns 截图路径
+   */
+  public async takeScreenshotByNode(
+    node: Node,
+    overlayHiddenScreenshotDelayMillis: number = 250
+  ): Promise<string> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.takeScreenshotNodes(
+      [node],
+      overlayHiddenScreenshotDelayMillis
+    );
+    Step.assert(this.step.stepId);
+    return result[0];
+  }
+
+  /**
+   * 对多个节点进行截图
+   * @param nodes 目标节点数组
+   * @param overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)
+   * @returns 截图路径数组
+   */
+  public async takeScreenshotNodes(
+    nodes: Node[],
+    overlayHiddenScreenshotDelayMillis: number = 250
+  ): Promise<string[]> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.takeScreenshotNodes(
+      nodes,
+      overlayHiddenScreenshotDelayMillis
+    );
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  /**
+   * 获取所有符合条件的节点
+   * @param filterClass 类名过滤
+   * @param filterViewId 视图ID过滤
+   * @param filterDes 描述过滤
+   * @param filterText 文本过滤
+   * @returns 节点数组
+   */
+  public async getAllNodes({
+    filterClass,
+    filterViewId,
+    filterDes,
+    filterText,
+  }: {
+    filterClass?: string;
+    filterViewId?: string;
+    filterDes?: string;
+    filterText?: string;
+  } = {}): Promise<Node[]> {
+    Step.assert(this.step.stepId);
+    const nodes = await AssistsXAsync.getAllNodes({
+      filterClass,
+      filterViewId,
+      filterDes,
+      filterText,
+    });
+    Step.assert(this.step.stepId);
+    Step.assignIdsToNodes(nodes, this.step.stepId);
+    return nodes;
+  }
+
+  /**
+   * 启动应用
+   * @param packageName 应用包名
+   * @returns 是否启动成功
+   */
+  public async launchApp(packageName: string): Promise<boolean> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.launchApp(packageName);
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  /**
+   * 获取当前应用包名
+   * @returns 包名
+   */
+  public async getPackageName(): Promise<string> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.getPackageName();
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  /**
+   * 通过ID查找节点
+   * @param id 节点ID
+   * @param filterClass 类名过滤
+   * @param filterText 文本过滤
+   * @param filterDes 描述过滤
+   * @returns 节点数组
+   */
+  public async findById(
+    id: string,
+    {
+      filterClass,
+      filterText,
+      filterDes,
+    }: { filterClass?: string; filterText?: string; filterDes?: string } = {}
+  ): Promise<Node[]> {
+    Step.assert(this.step.stepId);
+    const nodes = await AssistsXAsync.findById(id, {
+      filterClass,
+      filterText,
+      filterDes,
+    });
+    Step.assert(this.step.stepId);
+    Step.assignIdsToNodes(nodes, this.step.stepId);
+    return nodes;
+  }
+
+  /**
+   * 通过文本查找节点
+   * @param text 要查找的文本
+   * @param filterClass 类名过滤
+   * @param filterViewId 视图ID过滤
+   * @param filterDes 描述过滤
+   * @returns 节点数组
+   */
+  public async findByText(
+    text: string,
+    {
+      filterClass,
+      filterViewId,
+      filterDes,
+    }: { filterClass?: string; filterViewId?: string; filterDes?: string } = {}
+  ): Promise<Node[]> {
+    Step.assert(this.step.stepId);
+    const nodes = await AssistsXAsync.findByText(text, {
+      filterClass,
+      filterViewId,
+      filterDes,
+    });
+    Step.assert(this.step.stepId);
+    Step.assignIdsToNodes(nodes, this.step.stepId);
+    return nodes;
+  }
+
+  /**
+   * 通过标签查找节点
+   * @param className 类名
+   * @param filterText 文本过滤
+   * @param filterViewId 视图ID过滤
+   * @param filterDes 描述过滤
+   * @returns 节点数组
+   */
+  public async findByTags(
+    className: string,
+    {
+      filterText,
+      filterViewId,
+      filterDes,
+    }: { filterText?: string; filterViewId?: string; filterDes?: string } = {}
+  ): Promise<Node[]> {
+    Step.assert(this.step.stepId);
+    const nodes = await AssistsXAsync.findByTags(className, {
+      filterText,
+      filterViewId,
+      filterDes,
+    });
+    Step.assert(this.step.stepId);
+    Step.assignIdsToNodes(nodes, this.step.stepId);
+    return nodes;
+  }
+
+  /**
+   * 查找所有匹配文本的节点
+   * @param text 要查找的文本
+   * @returns 节点数组
+   */
+  public async findByTextAllMatch(text: string): Promise<Node[]> {
+    Step.assert(this.step.stepId);
+    const nodes = await AssistsXAsync.findByTextAllMatch(text);
+    Step.assert(this.step.stepId);
+    Step.assignIdsToNodes(nodes, this.step.stepId);
+    return nodes;
+  }
+
+  /**
+   * 检查是否包含指定文本
+   * @param text 要检查的文本
+   * @returns 是否包含
+   */
+  public async containsText(text: string): Promise<boolean> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.containsText(text);
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  /**
+   * 获取所有文本
+   * @returns 文本数组
+   */
+  public async getAllText(): Promise<string[]> {
+    Step.assert(this.step.stepId);
+    const texts = await AssistsXAsync.getAllText();
+    Step.assert(this.step.stepId);
+    return texts;
+  }
+
+  /**
+   * 执行点击手势
+   * @param x 横坐标
+   * @param y 纵坐标
+   * @param duration 持续时间(毫秒)
+   * @returns 是否成功
+   */
+  public async clickByGesture(
+    x: number,
+    y: number,
+    duration: number
+  ): Promise<boolean> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.clickByGesture(x, y, duration);
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  public async longPressGestureAutoPaste(
+    point: { x: number; y: number },
+    text: string,
+    {
+      matchedPackageName,
+      matchedText,
+      timeoutMillis,
+      longPressDuration,
+    }: {
+      matchedPackageName?: string;
+      matchedText?: string;
+      timeoutMillis?: number;
+      longPressDuration?: number;
+    } = { matchedText: "粘贴", timeoutMillis: 1500, longPressDuration: 600 }
+  ): Promise<boolean> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.longPressGestureAutoPaste(point, text, {
+      matchedPackageName,
+      matchedText,
+      timeoutMillis,
+      longPressDuration,
+    });
+    Step.assert(this.step.stepId);
+    return result;
+  }
+  public async getAppInfo(packageName: string): Promise<any> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.getAppInfo(packageName);
+    Step.assert(this.step.stepId);
+    return result;
+  }
+  public async performLinearGesture(
+    startPoint: { x: number; y: number },
+    endPoint: { x: number; y: number },
+    { duration }: { duration?: number } = {}
+  ): Promise<boolean> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.performLinearGesture(
+      startPoint,
+      endPoint,
+      {
+        duration,
+      }
+    );
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  /**
+   * 返回操作
+   * @returns 是否成功
+   */
+  public async back(): Promise<boolean> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.back();
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  /**
+   * 回到主页
+   * @returns 是否成功
+   */
+  public async home(): Promise<boolean> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.home();
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  /**
+   * 打开通知栏
+   * @returns 是否成功
+   */
+  public async notifications(): Promise<boolean> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.notifications();
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  /**
+   * 显示最近应用
+   * @returns 是否成功
+   */
+  public async recentApps(): Promise<boolean> {
+    Step.assert(this.step.stepId);
+    const result = await AssistsXAsync.recentApps();
+    Step.assert(this.step.stepId);
+    return result;
+  }
+
+  /**
+   * 获取屏幕尺寸
+   * @returns 屏幕尺寸对象
+   */
+  public async getScreenSize(): Promise<any> {
+    Step.assert(this.step.stepId);
+    const data = await AssistsXAsync.getScreenSize();
+    Step.assert(this.step.stepId);
+    return data;
+  }
+
+  /**
+   * 获取应用窗口尺寸
+   * @returns 应用窗口尺寸对象
+   */
+  public async getAppScreenSize(): Promise<any> {
+    Step.assert(this.step.stepId);
+    const data = await AssistsXAsync.getAppScreenSize();
+    Step.assert(this.step.stepId);
+    return data;
+  }
+}

package/src/StepError.ts

@@ -0,0 +1,47 @@
+/**
+ * 步骤执行错误类
+ * 用于携带步骤执行过程中的错误信息和当前步骤对象
+ */
+export class StepError extends Error {
+  /**
+   * 步骤实现函数名
+   */
+  readonly impl: string;
+
+  /**
+   * 步骤标签
+   */
+  readonly tag: string | undefined;
+
+  /**
+   * 步骤数据
+   */
+  readonly data: any | undefined;
+
+  /**
+   * 原始错误
+   */
+  readonly originalError: any;
+
+  /**
+   * 当前步骤对象
+   */
+  readonly currentStep: any | undefined;
+
+  constructor(
+    message: string,
+    impl: string,
+    tag: string | undefined,
+    data: any | undefined,
+    originalError: any,
+    currentStep: any | undefined
+  ) {
+    super(message);
+    this.name = "StepError";
+    this.impl = impl;
+    this.tag = tag;
+    this.data = data;
+    this.originalError = originalError;
+    this.currentStep = currentStep;
+  }
+}

package/src/Utils.ts

@@ -1,13 +1,22 @@
 // 导出工具函数
 export function sleep(ms: number): Promise<void> {
-    return new Promise(resolve => setTimeout(resolve, ms));
+  return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
 // 生成UUID
 export function generateUUID(): string {
-    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
-        const r = Math.random() * 16 | 0;
-        const v = c === 'x' ? r : (r & 0x3 | 0x8);
-        return v.toString(16);
-    });
-}
+  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
+    const r = (Math.random() * 16) | 0;
+    const v = c === "x" ? r : (r & 0x3) | 0x8;
+    return v.toString(16);
+  });
+}
+
+export function decodeBase64UTF8(base64: string): string {
+  const binary = atob(base64);
+  const bytes = new Uint8Array(binary.length);
+  for (let i = 0; i < binary.length; i++) {
+    bytes[i] = binary.charCodeAt(i);
+  }
+  return new TextDecoder("utf-8").decode(bytes);
+}

package/src/global.d.ts

@@ -1,15 +1,18 @@
-import { Node } from './Node';
+import { Node } from "./Node";
 
 // 扩展 Window 接口
 declare global {
-    interface Window {
-        assistsx: {
-            call(method: string): string | null;
-        };
-        assistsxCallback: (id: string, data: string) => void;
-        onAccessibilityEvent: (event: any) => void;
-    }
+  interface Window {
+    assistsx: {
+      call(method: string): string | null;
+    };
+    assistsxAsync: {
+      call(method: string): string | null;
+    };
+    assistsxCallback: (id: string, data: string) => void;
+    onAccessibilityEvent: (event: any) => void;
+  }
 }
 
 // 确保这个文件被视为模块
-export { }; 
+export {};

package/src/index.ts

@@ -1,10 +1,13 @@
-export * from './AssistsX';
-export * from './Node';
-export * from './CallMethod';
-export * from './CallResponse';
-export * from './NodeClassValue';
-export * from './Utils';
-export * from './Bounds';
-export * from './Step';
-export * from './StepStateStore';
-export * from './WindowFlags';
+export * from "./AssistsX";
+export * from "./Node";
+export * from "./CallMethod";
+export * from "./CallResponse";
+export * from "./NodeClassValue";
+export * from "./Utils";
+export * from "./Bounds";
+export * from "./Step";
+export * from "./StepStateStore";
+export * from "./WindowFlags";
+export * from "./NodeAsync";
+export * from "./AssistsXAsync";
+export * from "./StepAsync";