ms-types 0.0.17 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ms-types",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "type": "module",
   "license": "MIT",
   "publishConfig": {

package/types/action.d.ts

@@ -38,6 +38,23 @@ declare namespace action {
     jitter: boolean,
     steps: number
   ): boolean;
+  /**
+   * 随机点击
+   * @param x1 区域左上角x坐标
+   * @param y1 区域左上角y坐标
+   * @param x2 区域右下角x坐标
+   * @param y2 区域右下角y坐标
+   * @param duration 持续时间
+   * @returns 随机点击是否成功
+   * @example action.clickRandom(100, 100, 200, 200, 20)
+   */
+  function clickRandom(
+    x1: number,
+    y1: number,
+    x2: number,
+    y2: number,
+    duration: number
+  ): boolean;
   /**
    * 长按滑动
    * @param startX 起始坐标x
@@ -63,6 +80,28 @@ declare namespace action {
     jitter: boolean,
     steps: number
   ): boolean;
+  /**
+   * 3点曲线滑动（先快后慢，拟人化轨迹）
+   * 使用二次贝塞尔曲线算法，添加随机偏移和时间抖动，模拟真实人手操作
+   * @param startX 起始x坐标
+   * @param startY 起始y坐标
+   * @param midX 中间点x坐标（控制曲线弯曲程度）
+   * @param midY 中间点y坐标（控制曲线弯曲程度）
+   * @param endX 目标x坐标
+   * @param endY 目标y坐标
+   * @param duration 总持续时间（毫秒），实际执行时间会有随机变化
+   * @returns 曲线滑动是否成功
+   * @example action.swipeCurve(100, 100, 200, 150, 300, 200, 1000)
+   */
+  function swipeCurve(
+    startX: number,
+    startY: number,
+    midX: number,
+    midY: number,
+    endX: number,
+    endY: number,
+    duration: number
+  ): boolean;
   /**
    * 返回首页
    * @returns 返回首页是否成功

package/types/appleOcr.d.ts

@@ -14,7 +14,7 @@ declare namespace appleOcr {
    * @example
    * const results = appleOcr.recognize("screen", 0, 0, 100, 100, ["zh-Hans", "en-US"])
    * results.forEach(result => {
-   *   console.log(`文本: ${result.text}, 置信度: ${result.confidence}`)
+   *   logger.info(`文本: ${result.text}, 置信度: ${result.confidence}`)
    * })
    */
   function recognize(

package/types/global.d.ts

@@ -37,11 +37,24 @@ declare const __package__: {
   /**
    * 应用版本
    */
-  version: string;
+  appVersion: string;
   /**
-   * 应用描述
+   * 应用 Id
    */
-  description: string;
+  appId: string;
+  /**
+   * 应用更新参数
+   */
+  update: {
+    /**
+     * 应用更新地址
+     */
+    url: string;
+    /**
+     * 应用更新超时时间
+     */
+    timeout: number;
+  };
   [key: string]: any;
 };
 
@@ -60,6 +73,52 @@ declare function exit(): void;
  */
 declare function time(): number;
 /**
- * 把 app 切换到前台
+ * 把 app 切换到前台 utils.takeMeToFront 的别名
+ * @see utils.takeMeToFront
  */
 declare function takeMeToFront(): void;
+/**
+ * 重启脚本
+ * @param delay 延迟时间 毫秒
+ */
+declare function restartScript(delay: number): void;
+/**
+ * 日志调试 - 输出调试级别的日志
+ * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
+ * @param message 日志消息内容
+ * @see logger.debug
+ * @example
+ * logd("程序开始执行");
+ * logd(`当前用户: ${username}`);
+ */
+declare function logd(message: string): void;
+/**
+ * 日志信息 - 输出信息级别的日志
+ * 用于程序正常运行信息、重要操作的确认、状态变更通知
+ * @param message 日志消息内容
+ * @see logger.info
+ * @example
+ * logi("应用程序启动成功");
+ * logi("用户登录成功");
+ */
+declare function logi(message: string): void;
+/**
+ * 日志警告 - 输出警告级别的日志
+ * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
+ * @param message 日志消息内容
+ * @see logger.warn
+ * @example
+ * logw("电池电量低于 20%");
+ * logw("网络连接不稳定");
+ */
+declare function logw(message: string): void;
+/**
+ * 日志错误 - 输出错误级别的日志
+ * 用于程序错误和异常、操作失败、系统错误、致命问题
+ * @param message 日志消息内容
+ * @see logger.error
+ * @example
+ * loge("网络请求失败");
+ * loge("文件读取错误");
+ */
+declare function loge(message: string): void;

package/types/hotUpdate.d.ts

@@ -0,0 +1,106 @@
+/**
+ * 热更新模块类型定义
+ * 提供应用热更新功能，包括检查更新、下载更新包、MD5校验等
+ */
+
+/**
+ * 热更新检查结果
+ */
+interface HotUpdateResult {
+  /** 是否需要更新 */
+  needUpdate: boolean;
+  /** 错误信息（当检查失败时） */
+  error?: string;
+  /** 服务器返回的更新数据（当 needUpdate 为 true 时） */
+  data?: HotUpdateResponse;
+}
+
+/**
+ * 热更新服务器响应数据结构
+ */
+interface HotUpdateResponse {
+  /** 新包的下载地址 */
+  download_url: string;
+  /** 新包的版本号 */
+  version: number;
+  /** 下载msbundle文件超时时间（秒） */
+  download_timeout: number;
+  /** 是否用对话框的形式展示 */
+  dialog: boolean;
+  /** 对话框中要显示的消息 */
+  msg: string;
+  /** 对话框模式下是否强制更新 */
+  force: boolean;
+  /** 更新包文件的MD5值，用于校验文件完整性 */
+  md5?: string;
+}
+
+/**
+ * 热更新配置选项
+ */
+interface HotUpdateOptions {
+  /** 检查更新的服务器URL，未提供时从 package.json 的 update.url 读取 */
+  url?: string;
+  /** 当前版本号，未提供时从 package.json 的 appVersion 读取 */
+  version?: number;
+  /** 超时时间（毫秒），未提供时从 package.json 的 update.timeout 读取，默认10000毫秒 */
+  timeout?: number;
+}
+
+declare namespace hotUpdate {
+  /**
+   * 检查更新（同步调用）
+   * @param options 更新配置选项（可选，不传则从package.json读取配置）
+   * @returns 检查结果
+   *
+   * @example
+   * // 检查更新（使用默认配置）
+   * const result = hotUpdate.checkUpdate();
+   *
+   * // 或者传入自定义配置
+   * const result2 = hotUpdate.checkUpdate({
+   *   url: 'https://api.example.com/check-update'
+   * });
+   *
+   * if (result.needUpdate) {
+   *   logger.info('发现新版本');
+   *   // 手动决定是否更新
+   *   const installResult = hotUpdate.downloadAndInstall();
+   *   logger.info('安装结果:', installResult);
+   * } else {
+   *   logger.error('检查更新失败:', result.error);
+   * }
+   */
+  function checkUpdate(options?: HotUpdateOptions): HotUpdateResult;
+
+  /**
+   * 手动下载并安装更新, 执行成功后会自动重启脚本
+   * @returns 安装结果
+   * @example
+   * ```javascript
+   * const checkResult = hotUpdate.checkUpdate();
+   * if (checkResult.needUpdate) {
+   *   const installResult = hotUpdate.downloadAndInstall();
+   *   if (installResult.updated) {
+   *     logger.info('更新安装成功');
+   *   } else {
+   *     logger.error('更新安装失败:', installResult.error);
+   *   }
+   * }
+   * ```
+   */
+  function downloadAndInstall(): {
+    updated: boolean;
+    error?: string;
+  };
+
+  /**
+   * 获取当前应用版本号
+   * 从 package.json 文件中读取 appVersion 字段并返回数字类型版本号
+   * @returns {number} 当前版本号，如果获取失败则返回 0
+   * @example
+   * const version = hotUpdate.getCurrentVersion();
+   * logger.info('当前版本:', version); // 输出: 当前版本: 123
+   */
+  function getCurrentVersion(): number;
+}

package/types/index.d.ts

@@ -4,6 +4,7 @@
 /// <reference path="device.d.ts" />
 /// <reference path="file.d.ts" />
 /// <reference path="global.d.ts" />
+/// <reference path="hotUpdate.d.ts" />
 /// <reference path="http.d.ts" />
 /// <reference path="image.d.ts" />
 /// <reference path="ime.d.ts" />

package/types/paddleOcr.d.ts

@@ -9,7 +9,7 @@ declare namespace paddleOcr {
    * @example
    * const loaded = paddleOcr.loadV5(true)
    * if (loaded) {
-   *   console.log("加载成功")
+   *   logger.info("加载成功")
    * }
    */
   function loadV5(useGpu: boolean): boolean;
@@ -24,7 +24,7 @@ declare namespace paddleOcr {
    * @example
    * const results = paddleOcr.recognize("screen", 0, 0, 100, 100)
    * if (results.length > 0) {
-   *   console.log("识别到文本")
+   *   logger.info("识别到文本")
    * }
    */
   function recognize(

package/types/system.d.ts

@@ -158,4 +158,14 @@ declare namespace system {
    * logger.info(`可用内存: ${availableMemory}MB`)
    */
   function getAvailableMemory(): number;
+  /**
+   * 启动 WDA 服务
+   * @returns 是否启动成功
+   * @example
+   * const started = system.startWDA()
+   * if (started) {
+   *   logger.info("WDA 启动成功")
+   * }
+   */
+  function startWDA(): boolean;
 }

package/types/ui.d.ts

@@ -1,74 +1,112 @@
-/**
- * 注册UI函数 网页页面使用，给主进程调用
- * @param name 函数名称
- * @param func 函数
- */
-declare function registerUIFunc(
-  name: string,
-  func: (data: Record<string, any>) => void
-): void;
+declare namespace ms {
+  /**
+   * 注册UI函数 网页页面使用，给主进程调用
+   * @param name 函数名称
+   * @param func 函数
+   */
+  function registerUIFunc(
+    name: string,
+    func: (data: Record<string, any>) => void
+  ): void;
 
-/**
- * 发送事件 网页页面使用 给主进程发送事件
- * @param event 事件名称
- * @param data 事件参数
- */
-declare function emitEvent(event: string, data: Record<string, any>): void;
+  /**
+   * 发送事件 网页页面使用 给主进程发送事件
+   * @param event 事件名称
+   * @param data 事件参数
+   */
+  function emitEvent(event: string, data: Record<string, any>): void;
+
+  /**
+   * 启动脚本 网页页面使用
+   * @returns 如果启动成功返回true，否则返回false
+   */
+  function startTask(): Promise<boolean>;
+
+  /**
+   * 停止脚本 网页页面使用
+   * @returns 如果停止成功返回false，否则返回true
+   */
+  function stopTask(): Promise<boolean>;
+
+  /**
+   * 检查脚本是否正在运行 网页页面使用
+   * @returns 如果脚本正在运行返回true，否则返回false
+   */
+  function isTaskRunning(): Promise<boolean>;
+
+  /**
+   * 设置配置项
+   * @param key 配置项键
+   * @param value 配置项值
+   * @returns 如果设置成功返回true，否则返回false
+   */
+  function setConfig(key: string, value: any): Promise<boolean>;
+
+  /**
+   * 获取配置项
+   * @param key 配置项键
+   * @returns 配置项值
+   */
+  function getConfig(key: string): Promise<any>;
+
+  /**
+   * 移除配置项
+   * @param key 配置项键
+   * @returns 如果移除成功返回true，否则返回false
+   */
+  function removeConfig(key: string): Promise<boolean>;
+
+  /**
+   * 获取所有配置的字典
+   * @returns 包含所有配置的字典
+   */
+  function getAllConfig(): Promise<Record<string, any>>;
+
+  /**
+   * 设置所有配置
+   * @param configs 包含所有配置的字典
+   * @returns 如果设置成功返回true，否则返回false
+   */
+  function setAllConfig(configs: Record<string, any>): Promise<boolean>;
+
+  /**
+   * 获取WDA状态
+   * @returns 如果WDA正在运行返回true，否则返回false
+   */
+  function getWDAStatus(): Promise<boolean>;
+
+  /**
+   * 启动WDA服务
+   * @returns 如果调用成功返回true，否则返回false。注意：返回值仅表示调用是否成功，不代表WDA服务是否启动成功
+   */
+  function startWDA(): Promise<boolean>;
+}
 
 /**
- * UI模块 包含加载html文件、调用js方法等功能
+ * UI模块 提供WebView相关功能
  */
 declare namespace ui {
-  interface WebView {
-    /**
-     * 显示WebView
-     * @example
-     * webview.show()
-     */
-    show(): void;
-    /**
-     * 关闭WebView
-     * @example
-     * webview.close()
-     */
-    close(): void;
-    /**
-     * 调用WebView中的方法
-     * @param key 方法名
-     * @param data 方法参数
-     * @example
-     * webview.call("jsMethod", {
-     *   name: "magicscript",
-     * })
-     */
-    call(key: string, data: Record<string, any>): void;
-  }
   /**
-   * 创建WebView
-   * @param file 文件名
-   * @param onEvent 事件回调
-   * @returns WebView实例
+   * 设置事件回调函数
+   * @param onEvent 事件回调函数
    * @example
-   * const webview = ui.newWebView("index.html", (event, data) => {
+   * ui.onEvent((event, data) => {
    *   // 接收网页发送的事件
-   *   if(event === "page.loaded") {
-   *     logger.info("页面加载完成")
-   *   } else if(event === "page.close") {
-   *     logger.info("页面关闭")
-   *   } else if(event === "console.log") {
-   *     logger.info("网页调用console.log:" + data)
-   *   } else {
-   *     // 自定义事件
-   *     logger.info(event, data)
-   *   }
+   *   logger.info(`event: ${event}, data: ${JSON.stringify(data)}`)
    * })
-   * webview.show()
-   * webview.call("jsMethod", {
+   */
+  function onEvent(
+    onEvent: (event: string, data: Record<string, any>) => void
+  ): void;
+
+  /**
+   * 调用WebView中的JavaScript函数
+   * @param key 函数名 registerUIFunc 注册的函数名
+   * @param data 传递的数据
+   * @example
+   * ui.call("jsMethod", {
    *   name: "magicscript",
    * })
    */
-  function newWebView(
-    file: string,
-    onEvent: (event: string, data: string | Record<string, any>) => void
-  ): WebView;
+  function call(key: string, data: any): void;
 }

package/types/yolo.d.ts

@@ -49,7 +49,7 @@ declare interface YoloResult {
  */
 declare namespace yolo {
   /**
-   * 加载YOLOv11模型
+   * 加载YOLOv11模型 （兼容 yolov8 模型）
    * @param paramPath ncnn模型的param文件的绝对路径
    * @param binPath ncnn模型的bin文件绝对路径
    * @param nc 模型的标签数量,可在标签集data.yaml中看到