assistsx-js 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -1,5 +1,14 @@
 import * as pinia from 'pinia';
 
+/**
+ * 与 Android AssistsCore.NodeLookupScope / HTTP scope 查询参数一致的字符串取值。
+ */
+type NodeLookupScope = "active_window" | "all_windows";
+/** 与 AssistsCore.NodeLookupScope.ActiveWindow 对应 */
+declare const NODE_LOOKUP_SCOPE_ACTIVE_WINDOW: NodeLookupScope;
+/** 与 AssistsCore.NodeLookupScope.AllWindows 对应 */
+declare const NODE_LOOKUP_SCOPE_ALL_WINDOWS: NodeLookupScope;
+
 declare class Bounds {
     readonly left: number;
     readonly top: number;
@@ -890,7 +899,7 @@ interface Screen {
     height: number;
 }
 /** 全局屏幕尺寸，在 assistsxCallback 初始化后自动加载 */
-declare let screen: Screen | null;
+declare let screen: Screen;
 declare class AssistsX {
     /**
      * 屏幕尺寸（与全局变量 screen 同源）
@@ -940,11 +949,12 @@ declare class AssistsX {
      * @param filterText 文本过滤
      * @returns 节点数组
      */
-    static getAllNodes({ filterClass, filterViewId, filterDes, filterText, }?: {
+    static getAllNodes({ filterClass, filterViewId, filterDes, filterText, scope, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
         filterText?: string;
+        scope?: NodeLookupScope;
     }): Node[];
     /**
      * 设置节点文本
@@ -1012,7 +1022,9 @@ declare class AssistsX {
      * 获取当前应用包名
      * @returns 包名
      */
-    static getPackageName(): string;
+    static getPackageName(options?: {
+        scope?: NodeLookupScope;
+    }): string;
     /**
      * 显示悬浮提示
      * @param text 提示文本
@@ -1029,11 +1041,12 @@ declare class AssistsX {
      * @param node 父节点范围
      * @returns 节点数组
      */
-    static findById(id: string, { filterClass, filterText, filterDes, node, }?: {
+    static findById(id: string, { filterClass, filterText, filterDes, node, scope, }?: {
         filterClass?: string;
         filterText?: string;
         filterDes?: string;
         node?: Node;
+        scope?: NodeLookupScope;
     }): Node[];
     /**
      * 通过文本查找节点
@@ -1044,11 +1057,12 @@ declare class AssistsX {
      * @param node 父节点范围
      * @returns 节点数组
      */
-    static findByText(text: string, { filterClass, filterViewId, filterDes, node, }?: {
+    static findByText(text: string, { filterClass, filterViewId, filterDes, node, scope, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
         node?: Node;
+        scope?: NodeLookupScope;
     }): Node[];
     /**
      * 通过标签查找节点
@@ -1059,18 +1073,21 @@ declare class AssistsX {
      * @param node 父节点范围
      * @returns 节点数组
      */
-    static findByTags(className: string, { filterText, filterViewId, filterDes, node, }?: {
+    static findByTags(className: string, { filterText, filterViewId, filterDes, node, scope, }?: {
         filterText?: string;
         filterViewId?: string;
         filterDes?: string;
         node?: Node;
+        scope?: NodeLookupScope;
     }): Node[];
     /**
      * 查找所有匹配文本的节点
      * @param text 要查找的文本
-     * @returns 节点数组
+     * @param options.scope 节点查找范围（可选）
      */
-    static findByTextAllMatch(text: string): Node[];
+    static findByTextAllMatch(text: string, { scope }?: {
+        scope?: NodeLookupScope;
+    }): Node[];
     /**
      * 检查是否包含指定文本
      * @param text 要检查的文本
@@ -1464,11 +1481,12 @@ declare class StepAsync {
      * @param filterText 文本过滤
      * @returns 节点数组
      */
-    getAllNodes({ filterClass, filterViewId, filterDes, filterText, }?: {
+    getAllNodes({ filterClass, filterViewId, filterDes, filterText, scope, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
         filterText?: string;
+        scope?: NodeLookupScope;
     }): Promise<Node[]>;
     /**
      * 启动应用
@@ -1478,9 +1496,18 @@ declare class StepAsync {
     launchApp(packageName: string): Promise<boolean>;
     /**
      * 获取当前应用包名
-     * @returns 包名
+     * @param timeout 超时时间(秒)，默认30秒
      */
-    getPackageName(): Promise<string>;
+    getPackageName(timeout?: number): Promise<string>;
+    /**
+     * 获取当前应用包名
+     * @param options.timeout 超时时间(秒)，默认30秒
+     * @param options.scope 节点查找范围（可选）
+     */
+    getPackageName(options: {
+        timeout?: number;
+        scope?: NodeLookupScope;
+    }): Promise<string>;
     /**
      * 通过ID查找节点
      * @param id 节点ID
@@ -1489,10 +1516,11 @@ declare class StepAsync {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findById(id: string, { filterClass, filterText, filterDes, }?: {
+    findById(id: string, { filterClass, filterText, filterDes, scope, }?: {
         filterClass?: string;
         filterText?: string;
         filterDes?: string;
+        scope?: NodeLookupScope;
     }): Promise<Node[]>;
     /**
      * 通过文本查找节点
@@ -1502,10 +1530,11 @@ declare class StepAsync {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByText(text: string, { filterClass, filterViewId, filterDes, }?: {
+    findByText(text: string, { filterClass, filterViewId, filterDes, scope, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
+        scope?: NodeLookupScope;
     }): Promise<Node[]>;
     /**
      * 通过标签查找节点
@@ -1515,17 +1544,28 @@ declare class StepAsync {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByTags(className: string, { filterText, filterViewId, filterDes, }?: {
+    findByTags(className: string, { filterText, filterViewId, filterDes, scope, }?: {
         filterText?: string;
         filterViewId?: string;
         filterDes?: string;
+        scope?: NodeLookupScope;
     }): Promise<Node[]>;
     /**
      * 查找所有匹配文本的节点
      * @param text 要查找的文本
-     * @returns 节点数组
+     * @param timeout 超时时间(秒)，默认30秒
+     */
+    findByTextAllMatch(text: string, timeout?: number): Promise<Node[]>;
+    /**
+     * 查找所有匹配文本的节点
+     * @param text 要查找的文本
+     * @param options.timeout 超时时间(秒)，默认30秒
+     * @param options.scope 节点查找范围（可选）
      */
-    findByTextAllMatch(text: string): Promise<Node[]>;
+    findByTextAllMatch(text: string, options: {
+        timeout?: number;
+        scope?: NodeLookupScope;
+    }): Promise<Node[]>;
     /**
      * 检查是否包含指定文本
      * @param text 要检查的文本
@@ -1698,7 +1738,7 @@ declare class Step {
      */
     repeatCount: number;
     /**
-     * 步骤重复执行最大次数,默认不限制
+     * 步骤重复执行最大次数,默认15次
      */
     repeatCountMax: number;
     /**
@@ -1817,11 +1857,12 @@ declare class Step {
      * @param filterText 文本过滤
      * @returns 节点数组
      */
-    getAllNodes({ filterClass, filterViewId, filterDes, filterText, }?: {
+    getAllNodes({ filterClass, filterViewId, filterDes, filterText, scope, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
         filterText?: string;
+        scope?: NodeLookupScope;
     }): Node[];
     /**
      * 启动应用
@@ -1831,9 +1872,11 @@ declare class Step {
     launchApp(packageName: string): boolean;
     /**
      * 获取当前应用包名
-     * @returns 包名
+     * @param options.scope 节点查找范围（可选）
      */
-    getPackageName(): string;
+    getPackageName(options?: {
+        scope?: NodeLookupScope;
+    }): string;
     /**
      * 通过ID查找节点
      * @param id 节点ID
@@ -1842,10 +1885,11 @@ declare class Step {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findById(id: string, { filterClass, filterText, filterDes, }?: {
+    findById(id: string, { filterClass, filterText, filterDes, scope, }?: {
         filterClass?: string;
         filterText?: string;
         filterDes?: string;
+        scope?: NodeLookupScope;
     }): Node[];
     /**
      * 通过文本查找节点
@@ -1855,10 +1899,11 @@ declare class Step {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByText(text: string, { filterClass, filterViewId, filterDes, }?: {
+    findByText(text: string, { filterClass, filterViewId, filterDes, scope, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
+        scope?: NodeLookupScope;
     }): Node[];
     /**
      * 通过标签查找节点
@@ -1868,17 +1913,20 @@ declare class Step {
      * @param filterDes 描述过滤
      * @returns 节点数组
      */
-    findByTags(className: string, { filterText, filterViewId, filterDes, }?: {
+    findByTags(className: string, { filterText, filterViewId, filterDes, scope, }?: {
         filterText?: string;
         filterViewId?: string;
         filterDes?: string;
+        scope?: NodeLookupScope;
     }): Node[];
     /**
      * 查找所有匹配文本的节点
      * @param text 要查找的文本
-     * @returns 节点数组
+     * @param options.scope 节点查找范围（可选）
      */
-    findByTextAllMatch(text: string): Node[];
+    findByTextAllMatch(text: string, { scope }?: {
+        scope?: NodeLookupScope;
+    }): Node[];
     /**
      * 检查是否包含指定文本
      * @param text 要检查的文本
@@ -2118,12 +2166,13 @@ declare class AssistsXAsync {
      * @param timeout 超时时间(秒)，默认30秒
      * @returns 节点数组
      */
-    static getAllNodes({ filterClass, filterViewId, filterDes, filterText, timeout, }?: {
+    static getAllNodes({ filterClass, filterViewId, filterDes, filterText, timeout, scope, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
         filterText?: string;
         timeout?: number;
+        scope?: NodeLookupScope;
     }): Promise<Node[]>;
     /**
      * 设置节点文本
@@ -2219,9 +2268,17 @@ declare class AssistsXAsync {
     /**
      * 获取当前应用包名
      * @param timeout 超时时间(秒)，默认30秒
-     * @returns 包名
      */
     static getPackageName(timeout?: number): Promise<string>;
+    /**
+     * 获取当前应用包名
+     * @param options.timeout 超时时间(秒)，默认30秒
+     * @param options.scope 节点查找范围（可选）
+     */
+    static getPackageName(options: {
+        timeout?: number;
+        scope?: NodeLookupScope;
+    }): Promise<string>;
     /**
      * 显示悬浮提示
      * @param text 提示文本
@@ -2240,12 +2297,13 @@ declare class AssistsXAsync {
      * @param timeout 超时时间(秒)，默认30秒
      * @returns 节点数组
      */
-    static findById(id: string, { filterClass, filterText, filterDes, node, timeout, }?: {
+    static findById(id: string, { filterClass, filterText, filterDes, node, timeout, scope, }?: {
         filterClass?: string;
         filterText?: string;
         filterDes?: string;
         node?: Node;
         timeout?: number;
+        scope?: NodeLookupScope;
     }): Promise<Node[]>;
     /**
      * 通过文本查找节点
@@ -2257,12 +2315,13 @@ declare class AssistsXAsync {
      * @param timeout 超时时间(秒)，默认30秒
      * @returns 节点数组
      */
-    static findByText(text: string, { filterClass, filterViewId, filterDes, node, timeout, }?: {
+    static findByText(text: string, { filterClass, filterViewId, filterDes, node, timeout, scope, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
         node?: Node;
         timeout?: number;
+        scope?: NodeLookupScope;
     }): Promise<Node[]>;
     /**
      * 通过标签查找节点
@@ -2274,20 +2333,30 @@ declare class AssistsXAsync {
      * @param timeout 超时时间(秒)，默认30秒
      * @returns 节点数组
      */
-    static findByTags(className: string, { filterText, filterViewId, filterDes, node, timeout, }?: {
+    static findByTags(className: string, { filterText, filterViewId, filterDes, node, timeout, scope, }?: {
         filterText?: string;
         filterViewId?: string;
         filterDes?: string;
         node?: Node;
         timeout?: number;
+        scope?: NodeLookupScope;
     }): Promise<Node[]>;
     /**
      * 查找所有匹配文本的节点
      * @param text 要查找的文本
      * @param timeout 超时时间(秒)，默认30秒
-     * @returns 节点数组
      */
     static findByTextAllMatch(text: string, timeout?: number): Promise<Node[]>;
+    /**
+     * 查找所有匹配文本的节点
+     * @param text 要查找的文本
+     * @param options.timeout 超时时间(秒)，默认30秒
+     * @param options.scope 节点查找范围（可选）
+     */
+    static findByTextAllMatch(text: string, options: {
+        timeout?: number;
+        scope?: NodeLookupScope;
+    }): Promise<Node[]>;
     /**
      * 检查是否包含指定文本
      * @param text 要检查的文本
@@ -2554,12 +2623,14 @@ declare class AssistsXAsync {
      * @param options.filePath 文件路径（可选，不提供则自动生成）
      * @param options.prettyPrint 是否格式化输出，默认为 true
      * @param options.timeout 超时时间(秒)，默认30秒
+     * @param options.scope 节点查找范围（可选）
      * @returns 保存的文件路径
      */
     static saveRootNodeTreeJson(options?: {
         filePath?: string;
         prettyPrint?: boolean;
         timeout?: number;
+        scope?: NodeLookupScope;
     }): Promise<string>;
     /**
      * 获取剪贴板文本内容
@@ -4228,4 +4299,4 @@ declare class Log {
 /** 默认单例，用法与 floatingwindow 模块导出的 float 一致 */
 declare const log: Log;
 
-export { type AccessibilityEvent, type AccessibilityEventData, AccessibilityEventFilter, type AccessibilityEventFilterConfig, type AccessibilityEventListener, AppInfo, AssistsX, AssistsXAsync, BarUtils, BarUtilsCallMethod, type BarUtilsCallMethodType, Bounds, CallMethod, type CallMethodType, CallResponse, type Contact, DeviceInfo, FileIO, type FileInfo, type FileListItem, type FileUploadInfo, FileUtils, Float, FloatCallMethod, type FloatCallMethodType, Gallery, type GalleryDeleteResponse, type GalleryResponse, Http, type HttpConfig, type HttpDownloadResponse, type HttpResponse, type ImageProcessResult, type ImageRotateDegree, type ImageSaveResult, type ImageSize, type ImageType, ImageUtils, Ime, ImeAction, type IsCurrentInputMethodResponse, type IsInputMethodEnabledResponse, Log, LogCallMethod, type LogCallMethodType, LogStream, type LogStreamType, type LogSubscribeUpdatePayload, type LogUpdateData, type LogUpdateEvent, type LogUploadOptions, type LogUploadResult, Mlkit, MlkitCallMethod, type MlkitCallMethodType, type MlkitRegion, Node, NodeAsync, NodeClassValue, type OpenInputMethodSettingsResponse, Path, type PerformEditorActionResponse, type RecognizeTextInScreenshotPosition, type RecognizeTextInScreenshotResult, type RecognizeTextRegion, type Screen, type ScreenTextJsonResult, type ScreenTextRecognitionResult, Step, StepAsync, StepError, type StepImpl, type StepInterceptor, type StepResult, type StepState, type StepStatus, StepStopError, type TextPosition, type WebFloatingWindowOptions, WindowFlags, accessibilityEventListeners, barUtils, callbacks, decodeBase64UTF8, fileIO, fileUtils, float, gallery, generateUUID, http, imageUtils, ime, log, logUpdateListeners, mlkit, pathUtils, screen, sleep, useStepStore };
+export { type AccessibilityEvent, type AccessibilityEventData, AccessibilityEventFilter, type AccessibilityEventFilterConfig, type AccessibilityEventListener, AppInfo, AssistsX, AssistsXAsync, BarUtils, BarUtilsCallMethod, type BarUtilsCallMethodType, Bounds, CallMethod, type CallMethodType, CallResponse, type Contact, DeviceInfo, FileIO, type FileInfo, type FileListItem, type FileUploadInfo, FileUtils, Float, FloatCallMethod, type FloatCallMethodType, Gallery, type GalleryDeleteResponse, type GalleryResponse, Http, type HttpConfig, type HttpDownloadResponse, type HttpResponse, type ImageProcessResult, type ImageRotateDegree, type ImageSaveResult, type ImageSize, type ImageType, ImageUtils, Ime, ImeAction, type IsCurrentInputMethodResponse, type IsInputMethodEnabledResponse, Log, LogCallMethod, type LogCallMethodType, LogStream, type LogStreamType, type LogSubscribeUpdatePayload, type LogUpdateData, type LogUpdateEvent, type LogUploadOptions, type LogUploadResult, Mlkit, MlkitCallMethod, type MlkitCallMethodType, type MlkitRegion, NODE_LOOKUP_SCOPE_ACTIVE_WINDOW, NODE_LOOKUP_SCOPE_ALL_WINDOWS, Node, NodeAsync, NodeClassValue, type NodeLookupScope, type OpenInputMethodSettingsResponse, Path, type PerformEditorActionResponse, type RecognizeTextInScreenshotPosition, type RecognizeTextInScreenshotResult, type RecognizeTextRegion, type Screen, type ScreenTextJsonResult, type ScreenTextRecognitionResult, Step, StepAsync, StepError, type StepImpl, type StepInterceptor, type StepResult, type StepState, type StepStatus, StepStopError, type TextPosition, type WebFloatingWindowOptions, WindowFlags, accessibilityEventListeners, barUtils, callbacks, decodeBase64UTF8, fileIO, fileUtils, float, gallery, generateUUID, http, imageUtils, ime, log, logUpdateListeners, mlkit, pathUtils, screen, sleep, useStepStore };