assistsx-js 0.2.2 → 0.2.4

package/dist/index.d.ts

@@ -768,6 +768,25 @@ declare class AppInfo {
     toJSON(): any;
 }
 
+/**
+ * AssistsX 当前运行插件信息（由宿主拦截 getCurrentPlugin 返回）
+ */
+declare class PluginInfo {
+    id: string;
+    name: string;
+    packageName: string;
+    versionName: string;
+    versionCode: number;
+    description: string;
+    path: string;
+    index: string;
+    port: number;
+    needScreenCapture: boolean;
+    constructor(id?: string, name?: string, packageName?: string, versionName?: string, versionCode?: number, description?: string, path?: string, index?: string, port?: number, needScreenCapture?: boolean);
+    static fromJSON(data: unknown): PluginInfo;
+    toJSON(): Record<string, unknown>;
+}
+
 /**
  * 设备信息实体类
  */
@@ -941,6 +960,16 @@ declare class AssistsX {
      * @returns 是否设置成功
      */
     static setOverlayFlagList(flags: number[]): boolean;
+    /**
+     * 设置悬浮窗可获取焦点（WebView 内输入框 focus 时调用）
+     * @returns 是否设置成功
+     */
+    static setOverlayInputFocus(): boolean;
+    /**
+     * 取消悬浮窗焦点（WebView 内输入框 blur 时调用）
+     * @returns 是否设置成功
+     */
+    static clearOverlayInputFocus(): boolean;
     /**
      * 获取所有符合条件的节点
      * @param filterClass 类名过滤
@@ -1269,6 +1298,10 @@ declare class AssistsX {
         timeout?: number;
     }): Promise<boolean>;
     static getAppInfo(packageName: string, timeout?: number): Promise<AppInfo>;
+    /**
+     * 获取当前运行的 AssistsX 插件信息（仅 AssistsX 宿主有效，否则返回 null）
+     */
+    static getCurrentPlugin(): PluginInfo | null;
     static getUniqueDeviceId(): any;
     static getAndroidID(): any;
     static getMacAddress(timeout?: number): Promise<any>;
@@ -1371,6 +1404,7 @@ declare const CallMethod: {
     readonly performLinearGesture: "performLinearGesture";
     readonly longPressGestureAutoPaste: "longPressGestureAutoPaste";
     readonly getAppInfo: "getAppInfo";
+    readonly getCurrentPlugin: "getCurrentPlugin";
     readonly getMacAddress: "getMacAddress";
     readonly getAndroidID: "getAndroidID";
     readonly getUniqueDeviceId: "getUniqueDeviceId";
@@ -1636,6 +1670,7 @@ declare class StepAsync {
     getAppScreenSize(): Promise<any>;
 }
 
+type StepData = Record<string, any>;
 type StepResult = Step | undefined;
 type StepImpl = (step: Step) => Promise<StepResult>;
 type StepInterceptor = (step: Step) => StepResult | Promise<StepResult>;
@@ -1645,6 +1680,14 @@ declare class Step {
     static repeatCountMaxDefault: number;
     static showLog: boolean;
     static exceptionRetryCountMaxDefault: number;
+    /**
+     * 判断步骤数据是否有效（非空且为普通对象）
+     */
+    private static isValidStepData;
+    /**
+     * 解析步骤数据：优先使用传入值，否则使用当前值，均无效时返回空对象
+     */
+    private static resolveStepData;
     /**
      * 当前执行步骤的ID
      */
@@ -1667,7 +1710,7 @@ declare class Step {
     static run(impl: StepImpl, { stepId, tag, data, delayMs, exceptionRetryCountMax, }?: {
         stepId?: string | undefined;
         tag?: string | undefined;
-        data?: any | undefined;
+        data?: StepData;
         delayMs?: number;
         exceptionRetryCountMax?: number;
     }): Promise<Step | undefined>;
@@ -1757,7 +1800,7 @@ declare class Step {
     /**
      * 步骤数据
      */
-    data: any | undefined;
+    data: StepData;
     /**
      * 步骤延迟时间(毫秒)
      */
@@ -1778,7 +1821,7 @@ declare class Step {
         stepId: string;
         impl: StepImpl | undefined;
         tag?: string | undefined;
-        data?: any | undefined;
+        data?: StepData;
         delayMs?: number;
         repeatCountMax?: number;
         exceptionRetryCountMax?: number;
@@ -1795,14 +1838,14 @@ declare class Step {
      */
     next(impl: StepImpl, { tag, data, delayMs, repeatCountMax, exceptionRetryCountMax, }?: {
         tag?: string | undefined;
-        data?: any | undefined;
+        data?: StepData;
         delayMs?: number;
         repeatCountMax?: number;
         exceptionRetryCountMax?: number;
     }): Step;
     end({ tag, data, delayMs, repeatCountMax, exceptionRetryCountMax, }?: {
         tag?: string | undefined;
-        data?: any | undefined;
+        data?: StepData;
         delayMs?: number;
         repeatCountMax?: number;
         exceptionRetryCountMax?: number;
@@ -1818,7 +1861,7 @@ declare class Step {
     repeat({ stepId, tag, data, delayMs, repeatCountMax, exceptionRetryCountMax, }?: {
         stepId?: string;
         tag?: string | undefined;
-        data?: any | undefined;
+        data?: StepData;
         delayMs?: number;
         repeatCountMax?: number;
         exceptionRetryCountMax?: number;
@@ -2012,6 +2055,8 @@ declare const useStepStore: pinia.StoreDefinition<"step", StepState, {}, {
     reset(): void;
 }>;
 
+declare function ensureAssistsXPinia(): void;
+
 /**
  * 窗口标志位常量类
  * 定义了各种窗口行为和属性的标志位
@@ -2076,6 +2121,10 @@ declare class WindowFlags {
      * @returns 新的标志位组合
      */
     static removeFlag(flags: number, flag: number): number;
+    /** 输入框获取焦点时使用的悬浮窗 flag 组合（不含 FLAG_NOT_FOCUSABLE） */
+    static getOverlayInputFocusFlagList(): number[];
+    /** 输入框失去焦点时使用的悬浮窗 flag 组合（含 FLAG_NOT_FOCUSABLE） */
+    static getOverlayInputBlurFlagList(): number[];
     /**
      * 获取所有标志位的描述信息
      * @returns 标志位描述对象数组
@@ -2157,6 +2206,14 @@ declare class AssistsXAsync {
      * @returns 是否设置成功
      */
     static setOverlayFlagList(flags: number[], timeout?: number): Promise<boolean>;
+    /**
+     * 设置悬浮窗可获取焦点（WebView 内输入框 focus 时调用）
+     */
+    static setOverlayInputFocus(timeout?: number): Promise<boolean>;
+    /**
+     * 取消悬浮窗焦点（WebView 内输入框 blur 时调用）
+     */
+    static clearOverlayInputFocus(timeout?: number): Promise<boolean>;
     /**
      * 获取所有符合条件的节点
      * @param filterClass 类名过滤
@@ -2555,6 +2612,10 @@ declare class AssistsXAsync {
         timeout?: number;
     }): Promise<boolean>;
     static getAppInfo(packageName: string, timeout?: number): Promise<AppInfo>;
+    /**
+     * 获取当前运行的 AssistsX 插件信息（仅 AssistsX 宿主有效，否则返回 null）
+     */
+    static getCurrentPlugin(timeout?: number): Promise<PluginInfo | null>;
     static getUniqueDeviceId(timeout?: number): Promise<any>;
     static getAndroidID(timeout?: number): Promise<any>;
     static getMacAddress(timeout?: number): Promise<any>;
@@ -4066,6 +4127,134 @@ declare const MlkitCallMethod: {
 };
 type MlkitCallMethodType = (typeof MlkitCallMethod)[keyof typeof MlkitCallMethod];
 
+type ScreenshotImageFormat = "PNG" | "JPEG" | "JPG" | "WEBP";
+/** takeScreenshotBase64 / takeNodeScreenshotBase64 返回数据 */
+interface ScreenshotBase64Data {
+    base64: string;
+    dataUrl: string;
+    mimeType: string;
+}
+interface TakeScreenshotBase64Options {
+    overlayHiddenScreenshotDelayMillis?: number;
+    format?: ScreenshotImageFormat;
+    withDataUrlPrefix?: boolean;
+    timeout?: number;
+}
+interface TakeScreenshotNodesBase64Options extends TakeScreenshotBase64Options {
+}
+declare class Screenshot {
+    /**
+     * 执行异步调用
+     */
+    private asyncCall;
+    private buildScreenshotArgs;
+    /**
+     * 截取全屏并返回 Base64
+     */
+    takeScreenshotBase64(options?: TakeScreenshotBase64Options): Promise<ScreenshotBase64Data | null>;
+    /**
+     * 截取指定节点区域并返回 Base64
+     */
+    takeNodeScreenshotBase64(nodeId: string, options?: TakeScreenshotBase64Options): Promise<ScreenshotBase64Data | null>;
+    /**
+     * 批量截取节点区域；nodeIds 为空时返回全屏截图
+     */
+    takeScreenshotNodesBase64(nodeIds?: string[], options?: TakeScreenshotNodesBase64Options): Promise<string[]>;
+}
+declare const screenshot: Screenshot;
+
+/**
+ * 截图相关的 JavascriptInterface 方法常量
+ */
+declare const ScreenshotCallMethod: {
+    /** 截取全屏并返回 Base64 */
+    readonly takeScreenshotBase64: "takeScreenshotBase64";
+    /** 截取指定节点区域并返回 Base64，需传 node.nodeId */
+    readonly takeNodeScreenshotBase64: "takeNodeScreenshotBase64";
+    /** 批量截取节点区域并返回 Base64 数组，nodes 为空时返回全屏 */
+    readonly takeScreenshotNodesBase64: "takeScreenshotNodesBase64";
+};
+type ScreenshotCallMethodType = (typeof ScreenshotCallMethod)[keyof typeof ScreenshotCallMethod];
+
+/** 数据库定位，dbPath 与 dbName 二选一 */
+interface DbTarget {
+    dbPath?: string;
+    dbName?: string;
+}
+/** exec 成功返回 */
+interface DbExecResult {
+    rowsAffected: number;
+    lastInsertRowId: number;
+}
+/** query 单行记录；BLOB 字段为 Base64 字符串 */
+type DbRow = Record<string, string | number | null>;
+/** query 成功返回 */
+interface DbQueryResult {
+    columns: string[];
+    rows: DbRow[];
+    rowCount: number;
+}
+/** execBatch 单条结果 */
+interface DbBatchItemResult {
+    rowsAffected: number;
+    lastInsertRowId: number;
+}
+/** execBatch 成功返回 */
+interface DbExecBatchResult {
+    count: number;
+    results: DbBatchItemResult[];
+}
+/** 公共调用选项 */
+interface DbCallOptions extends DbTarget {
+    bindArgs?: (string | number | boolean | null)[];
+    /** 超时时间（秒），默认 30 */
+    timeout?: number;
+}
+interface DbExecBatchOptions extends DbTarget {
+    /** 超时时间（秒），默认 30 */
+    timeout?: number;
+}
+declare class Db {
+    /**
+     * 执行异步调用
+     */
+    private asyncCall;
+    /**
+     * 将 query 结果中的 Base64 BLOB 字段解码为 Uint8Array
+     */
+    decodeBlobBase64(base64: string): Uint8Array;
+    /**
+     * 执行非查询 SQL
+     */
+    exec(sql: string, options: DbCallOptions): Promise<DbExecResult>;
+    /**
+     * 执行查询 SQL
+     */
+    query(sql: string, options: DbCallOptions): Promise<DbQueryResult>;
+    /**
+     * 事务内批量执行多条 SQL
+     */
+    execBatch(statements: string[], options: DbExecBatchOptions): Promise<DbExecBatchResult>;
+    /**
+     * 关闭并释放指定数据库连接
+     */
+    close(options: DbTarget & {
+        timeout?: number;
+    }): Promise<void>;
+}
+declare const db: Db;
+
+/**
+ * SQLite 数据库桥接方法名常量
+ */
+declare const DbCallMethod: {
+    readonly exec: "exec";
+    readonly query: "query";
+    readonly execBatch: "execBatch";
+    readonly close: "close";
+};
+type DbCallMethodType = (typeof DbCallMethod)[keyof typeof DbCallMethod];
+
 declare class BarUtils {
     private asyncCall;
     private errorMessage;
@@ -4197,6 +4386,8 @@ declare const LogCallMethod: {
     readonly uploadLogs: "uploadLogs";
     /** 获取日志服务当前域名（origin，无路径；与上传、管理后台同源），对应 AssistsLogDiagnostics.adminWebBaseUrl() */
     readonly getLogServiceBaseUrl: "getLogServiceBaseUrl";
+    /** 解析日志文件绝对路径（不创建文件） */
+    readonly resolveLogPath: "resolveLogPath";
 };
 /** 与 ASWebView / AssistsLogJavascriptInterface companion 对齐 */
 declare const LogStream: {
@@ -4206,6 +4397,15 @@ declare const LogStream: {
 type LogStreamType = (typeof LogStream)[keyof typeof LogStream];
 type LogCallMethodType = (typeof LogCallMethod)[keyof typeof LogCallMethod];
 
+/** 日志文件定位：dirPath 为绝对路径目录，fileName 不含 .txt 后缀 */
+interface LogTarget {
+    dirPath?: string;
+    fileName?: string;
+}
+interface LogCallOptions extends LogTarget {
+    /** 超时时间（秒），默认 30 */
+    timeout?: number;
+}
 /**
  * onAssistsLogUpdate 推送的监听器列表（与 accessibilityEventListeners 风格一致）。
  * 在页面加载本模块后，向此数组 push，或使用 log.addLogUpdateListener。
@@ -4213,7 +4413,7 @@ type LogCallMethodType = (typeof LogCallMethod)[keyof typeof LogCallMethod];
  */
 declare const logUpdateListeners: Array<(payload: LogUpdateEvent) => void>;
 /**
- * Base64 解码后的 CallResponse，data 含 stream / text
+ * Base64 解码后的 CallResponse，data 含 stream / text / logFilePath
  */
 interface LogUpdateEvent {
     code: number;
@@ -4224,13 +4424,15 @@ interface LogUpdateEvent {
 interface LogUpdateData {
     stream: LogStreamType;
     text: string;
+    logFilePath?: string;
 }
 interface LogSubscribeUpdatePayload {
     text: string;
     stream: string;
     subscriptionId: string;
+    logFilePath?: string;
 }
-interface LogUploadOptions {
+interface LogUploadOptions extends LogTarget {
     baseUrl?: string;
     /** PNG（默认）| JPEG | JPG | WEBP */
     format?: "PNG" | "JPEG" | "JPG" | "WEBP" | string;
@@ -4255,29 +4457,45 @@ declare class Log {
     private getBridge;
     private asyncCall;
     /** 读取当前日志全文 */
-    readAllText(timeout?: number): Promise<string>;
+    readAllText(timeoutOrOptions?: number | LogCallOptions): Promise<string>;
     /**
      * 获取日志服务当前域名（origin，无路径；与上传、管理后台同源）。
      * 与 Kotlin getLogServiceBaseUrl / adminWebBaseUrl 对齐。
      */
     getLogServiceBaseUrl(timeout?: number): Promise<string>;
+    /**
+     * 解析日志文件绝对路径（不创建文件）。
+     * AssistsX 插件环境下会经原生拦截追加 log-{packageName} 子目录。
+     */
+    resolveLogPath(targetOrOptions?: LogTarget | LogCallOptions): Promise<string>;
     /** 清空日志 */
-    clear(timeout?: number): Promise<boolean>;
+    clear(timeoutOrOptions?: number | LogCallOptions): Promise<boolean>;
     /** 从文件重新加载到内存 Flow */
-    refreshFromFile(timeout?: number): Promise<boolean>;
+    refreshFromFile(timeoutOrOptions?: number | LogCallOptions): Promise<boolean>;
     /** 追加一行 */
-    appendLine(line: string, maxLength?: number, timeout?: number): Promise<boolean>;
+    appendLine(line: string, maxLengthOrOptions?: number | (LogTarget & {
+        maxLength?: number;
+        timeout?: number;
+    }), timeout?: number): Promise<boolean>;
     /** 追加带时间戳的条目 */
-    appendTimestampedEntry(message: string, timeout?: number): Promise<boolean>;
+    appendTimestampedEntry(message: string, timeoutOrOptions?: number | LogCallOptions): Promise<boolean>;
+    /**
+     * 追加日志（appendTimestampedEntry / appendLine 简写）。
+     * 默认带时间戳；`timestamped: false` 时走 appendLine。
+     */
+    append(text: string, options?: LogTarget & {
+        /** @default true */
+        timestamped?: boolean;
+        maxLength?: number;
+        timeout?: number;
+    }): Promise<boolean>;
     /** 替换全部内容 */
-    replaceAll(content: string, timeout?: number): Promise<boolean>;
+    replaceAll(content: string, timeoutOrOptions?: number | LogCallOptions): Promise<boolean>;
     /**
      * 订阅 Flow：先收到 subscribed，再多次 update。
      * resolve 后请保留 dispose 或调用 unsubscribe(subscriptionId) 以释放原生协程与 JS 回调。
      */
-    subscribe(stream: LogStreamType, onUpdate: (payload: LogSubscribeUpdatePayload) => void, options?: {
-        timeout?: number;
-    }): Promise<{
+    subscribe(stream: LogStreamType, onUpdate: (payload: LogSubscribeUpdatePayload) => void, options?: LogCallOptions): Promise<{
         subscriptionId: string;
         dispose: () => Promise<void>;
     }>;
@@ -4299,4 +4517,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_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 };
+export { type AccessibilityEvent, type AccessibilityEventData, AccessibilityEventFilter, type AccessibilityEventFilterConfig, type AccessibilityEventListener, AppInfo, AssistsX, AssistsXAsync, BarUtils, BarUtilsCallMethod, type BarUtilsCallMethodType, Bounds, CallMethod, type CallMethodType, CallResponse, type Contact, Db, type DbBatchItemResult, DbCallMethod, type DbCallMethodType, type DbCallOptions, type DbExecBatchOptions, type DbExecBatchResult, type DbExecResult, type DbQueryResult, type DbRow, type DbTarget, 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, type LogCallOptions, LogStream, type LogStreamType, type LogSubscribeUpdatePayload, type LogTarget, 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, PluginInfo, type RecognizeTextInScreenshotPosition, type RecognizeTextInScreenshotResult, type RecognizeTextRegion, type Screen, type ScreenTextJsonResult, type ScreenTextRecognitionResult, Screenshot, type ScreenshotBase64Data, ScreenshotCallMethod, type ScreenshotCallMethodType, type ScreenshotImageFormat, Step, StepAsync, type StepData, StepError, type StepImpl, type StepInterceptor, type StepResult, type StepState, type StepStatus, StepStopError, type TakeScreenshotBase64Options, type TakeScreenshotNodesBase64Options, type TextPosition, type WebFloatingWindowOptions, WindowFlags, accessibilityEventListeners, barUtils, callbacks, db, decodeBase64UTF8, ensureAssistsXPinia, fileIO, fileUtils, float, gallery, generateUUID, http, imageUtils, ime, log, logUpdateListeners, mlkit, pathUtils, screen, screenshot, sleep, useStepStore };