ms-types 0.0.62 → 0.0.64

package/package.json

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

package/types/action.d.ts

@@ -23,27 +23,6 @@ declare namespace action {
     duration?: number,
     jitter?: boolean
   ): boolean;
-  /**
-   * 滑动
-   * @param startX 起始坐标x
-   * @param startY 起始坐标y
-   * @param endX 结束坐标x
-   * @param endY 结束坐标y
-   * @param duration 持续时间 默认 100ms
-   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 滑动 默认false
-   * @param steps 步数 生成抖动点数量 默认6
-   * @returns 滑动是否成功
-   * @example action.swipe(100, 100, 200, 200, 500, true, 10)
-   */
-  function swipe(
-    startX: number,
-    startY: number,
-    endX: number,
-    endY: number,
-    duration?: number,
-    jitter?: boolean,
-    steps?: number
-  ): boolean;
   /**
    * 随机点击
    * @param x1 区域左上角x坐标
@@ -97,6 +76,27 @@ declare namespace action {
     duration?: number,
     interval?: number
   ): boolean;
+  /**
+   * 滑动
+   * @param startX 起始坐标x
+   * @param startY 起始坐标y
+   * @param endX 结束坐标x
+   * @param endY 结束坐标y
+   * @param duration 持续时间 默认 100ms
+   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 滑动 默认false
+   * @param steps 步数 生成抖动点数量 默认6
+   * @returns 滑动是否成功
+   * @example action.swipe(100, 100, 200, 200, 500, true, 10)
+   */
+  function swipe(
+    startX: number,
+    startY: number,
+    endX: number,
+    endY: number,
+    duration?: number,
+    jitter?: boolean,
+    steps?: number
+  ): boolean;
   /**
    * 长按滑动
    * @param startX 起始坐标x

package/types/global.d.ts

@@ -2,39 +2,32 @@
  * 是否是调试模式
  */
 declare const __debug__: boolean;
-declare const $是否调试: boolean;
 /**
  * 是否应该退出应用
  */
 declare const __shouldExit__: boolean;
-declare const $是否退出: boolean;
 /**
  * 应用版本
  */
 declare const __appVersion__: string;
-declare const $APP应用版本: string;
 /**
  * 应用构建号
  */
 declare const __appBuildNumber__: string;
-declare const $APP应用构建号: string;
 /**
  * 应用名称
  */
 declare const __appName__: string;
-declare const $APP应用名称: string;
 /**
  * 应用 bundleId
  */
 declare const __bundleId__: string;
-declare const $APP应用包名: string;
 /**
  * 当前线程名称
  */
 declare const __threadName__: string;
-declare const $线程名称: string;
 /**
- * 应用包信息
+ * 脚本信息
  */
 declare const __package__: {
   /**
@@ -64,16 +57,6 @@ declare const __package__: {
   };
   [key: string]: any;
 };
-declare const $脚本配置: {
-  name: string;
-  appVersion: string;
-  appId: string;
-  update: {
-    url: string;
-    timeout: number;
-  };
-  [key: string]: any;
-};
 
 /**
  * 设置停止回调（仅主线程调用）
@@ -84,7 +67,7 @@ declare const $脚本配置: {
  *   logi("脚本执行完成");
  * });
  */
-declare function setStopCallback(callback: () => void): void;
+declare function setStopCallback(callback: Function): void;
 
 /**
  * 设置异常停止回调（仅主线程调用）
@@ -116,14 +99,16 @@ declare function restartScript(delay: number): void;
  * sleep(1000);
  */
 declare function sleep(ms: number): void;
+
 /**
- * 退出应用
+ * 退出脚本
  * @param exitAll 是否退出所有线程 true 退出所有 false 退出当前线程，不传默认 false
- * @description 退出应用会终止所有线程的执行
+ * @description 退出脚本会终止所有线程的执行
  * @example
  * exit();
  */
 declare function exit(exitAll?: boolean): void;
+
 /**
  * 获取当前时间戳
  * @returns 时间戳
@@ -131,6 +116,7 @@ declare function exit(exitAll?: boolean): void;
  * const timestamp = time();
  */
 declare function time(): number;
+
 /**
  * 把 app 切换到前台 utils.takeMeToFront 的别名
  * @see utils.takeMeToFront
@@ -139,8 +125,9 @@ declare function time(): number;
  * takeMeToFront();
  */
 declare function takeMeToFront(): void;
+
 /**
- * 日志调试 - 输出调试级别的日志
+ * 打印调试日志 - 输出调试级别的日志
  * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
  * @param args 日志消息内容
  * @see logger.debug
@@ -149,8 +136,9 @@ declare function takeMeToFront(): void;
  * logd(`当前用户: ${username}`);
  */
 declare function logd(...args: any[]): void;
+
 /**
- * 日志信息 - 输出信息级别的日志
+ * 打印信息日志 - 输出信息级别的日志
  * 用于程序正常运行信息、重要操作的确认、状态变更通知
  * @param args 日志消息内容
  * @see logger.info
@@ -159,8 +147,9 @@ declare function logd(...args: any[]): void;
  * logi("用户登录成功");
  */
 declare function logi(...args: any[]): void;
+
 /**
- * 日志警告 - 输出警告级别的日志
+ * 打印警告日志 - 输出警告级别的日志
  * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
  * @param args 日志消息内容
  * @see logger.warn
@@ -169,8 +158,9 @@ declare function logi(...args: any[]): void;
  * logw("网络连接不稳定");
  */
 declare function logw(...args: any[]): void;
+
 /**
- * 日志错误 - 输出错误级别的日志
+ * 打印错误日志 - 输出错误级别的日志
  * 用于程序错误和异常、操作失败、系统错误、致命问题
  * @param args 日志消息内容
  * @see logger.error

package/types/index.d.ts

@@ -22,3 +22,4 @@
 /// <reference path="ui.d.ts" />
 /// <reference path="utils.d.ts" />
 /// <reference path="yolo.d.ts" />
+/// <reference path="zh/index.d.ts" />

package/types/zh/index.d.ts

@@ -0,0 +1,2 @@
+/// <reference path="全局模块.d.ts" />
+/// <reference path="动作模块.d.ts" />

package/types/zh//345/205/250/345/261/200/346/250/241/345/235/227.d.ts

@@ -0,0 +1,161 @@
+declare type 回调 = Function;
+declare type 布尔值 = boolean;
+declare type 字符串 = string;
+declare type 数字 = number;
+declare type 任意类型 = any;
+declare type 日期时间 = Date;
+declare type 数组<T> = Array<T>;
+declare type 字典<T> = Record<字符串, T>;
+declare type 无返回值 = void;
+
+/**
+ * 是否是调试模式
+ */
+declare const $是否调试: boolean;
+/**
+ * 是否应该退出应用
+ */
+declare const $是否退出: boolean;
+/**
+ * 应用版本
+ */
+declare const $APP应用版本: string;
+/**
+ * 应用构建号
+ */
+declare const $APP应用构建号: string;
+/**
+ * 应用名称
+ */
+declare const $APP应用名称: string;
+/**
+ * 应用 bundleId
+ */
+declare const $APP应用包名: string;
+/**
+ * 当前线程名称
+ */
+declare const $线程名称: string;
+/**
+ * 脚本信息
+ */
+declare const $脚本配置: {
+  name: string;
+  appVersion: string;
+  appId: string;
+  update: {
+    url: string;
+    timeout: number;
+  };
+  [key: string]: any;
+};
+
+/**
+ * 设置停止回调（仅主线程调用）
+ * @param callback 停止回调
+ * @description 脚本执行完成或异常停止时调用，exit 退出不会触发
+ * @example
+ * $设置停止回调(() => {
+ *   $打印信息日志("脚本执行完成");
+ * });
+ */
+declare const $设置停止回调: (回调: 回调) => 无返回值;
+
+/**
+ * 设置异常停止回调（仅主线程调用）
+ * @param callback 异常停止回调
+ * @description 脚本执行异常停止时调用
+ * @example
+ * $设置异常停止回调(() => {
+ *   $打印错误日志("脚本执行异常");
+ * });
+ */
+declare const $设置异常停止回调: (回调: 回调) => 无返回值;
+
+/**
+ * 重启脚本（仅主线程调用）
+ * @param delay 延迟时间 毫秒
+ * @description 重启脚本会延迟指定时间后再重启，不要低于 2000 毫秒
+ * @example
+ * $重启脚本(2000);
+ */
+declare const $重启脚本: (延迟时间: 数字) => 无返回值;
+
+/**
+ * 线程睡眠
+ * @param ms 毫秒
+ * @description 线程睡眠会阻塞当前线程，等待指定时间后继续执行
+ * @example
+ * $延时(1000);
+ */
+declare const $延时: (毫秒: 数字) => 无返回值;
+
+/**
+ * 退出脚本
+ * @param 退出所有线程 是否退出所有线程 true 退出所有 false 退出当前线程，不传默认 false
+ * @description 退出脚本会终止所有线程的执行
+ * @example
+ * $退出脚本();
+ */
+declare const $退出脚本: (退出所有线程?: 布尔值) => 无返回值;
+
+/**
+ * 获取当前时间戳
+ * @returns 时间戳
+ * @example
+ * const timestamp = $获取当前时间戳();
+ */
+declare function $获取当前时间戳(): 数字;
+
+/**
+ * 把 app 切换到前台 utils.takeMeToFront 的别名
+ * @see utils.takeMeToFront
+ * @description 把 app 切换到前台
+ * @example
+ * $APP切入前台();
+ */
+declare function $APP切入前台(): 无返回值;
+
+/**
+ * 打印调试日志 - 输出调试级别的日志
+ * 用于详细的程序执行信息、变量值和状态信息、函数调用跟踪
+ * @param args 日志消息内容
+ * @see logger.debug
+ * @example
+ * $打印调试日志("程序开始执行");
+ * $打印调试日志(`当前用户: ${username}`);
+ */
+declare function $打印调试日志(...args: 数组<任意类型>): 无返回值;
+
+/**
+ * 打印信息日志 - 输出信息级别的日志
+ * 用于程序正常运行信息、重要操作的确认、状态变更通知
+ * @param args 日志消息内容
+ * @see logger.info
+ * @example
+ * $打印信息日志("应用程序启动成功");
+ * $打印信息日志("用户登录成功");
+ */
+declare function $打印信息日志(...args: 数组<任意类型>): 无返回值;
+
+/**
+ * 打印警告日志 - 输出警告级别的日志
+ * 用于潜在的问题、不推荐的操作、性能警告、兼容性问题
+ * @param args 日志消息内容
+ * @see logger.warn
+ * @example
+ * $打印警告日志("电池电量低于 20%");
+ * $打印警告日志("网络连接不稳定");
+ */
+declare function $打印警告日志(...args: 数组<任意类型>): 无返回值;
+
+/**
+ * 打印错误日志 - 输出错误级别的日志
+ * 用于程序错误和异常、操作失败、系统错误、致命问题
+ * @param args 日志消息内容
+ * @see logger.error
+ * @example
+ * $打印错误日志("网络请求失败");
+ * $打印错误日志("文件读取错误");
+ */
+declare function $打印错误日志(...args: 数组<任意类型>): 无返回值;

package/types/zh//345/212/250/344/275/234/346/250/241/345/235/227.d.ts

@@ -0,0 +1,298 @@
+/// <reference path="全局模块.d.ts" />
+
+/**
+ * 动作模块 包含点击、滑动、长按滑动、返回首页等动作
+ */
+declare namespace $动作 {
+  /**
+   * 设置动作抖动值 点击、滑动等动作会在像素范围-5到5随机偏移
+   * @param value 抖动值
+   * @example $动作.设置抖动值(5)
+   */
+  function 设置抖动值(抖动值: 数字): 无返回值;
+  /**
+   * 点击
+   * @param 坐标x
+   * @param 坐标y
+   * @param 按下持续时间 默认20ms
+   * @param 抖动 开启抖动，会在像素范围随机偏移 点击 默认false
+   * @returns 点击是否成功
+   * @example $动作.点击(100, 100, 20, true)
+   */
+  function 点击(
+    坐标x: 数字,
+    坐标y: 数字,
+    按下持续时间?: 数字,
+    抖动?: 布尔值
+  ): 布尔值;
+  /**
+   * 随机点击
+   * @param 区域左上角x坐标
+   * @param 区域左上角y坐标
+   * @param 区域右下角x坐标
+   * @param 区域右下角y坐标
+   * @param 按下持续时间 默认20ms
+   * @returns 随机点击是否成功
+   * @example $动作.点击随机范围(100, 100, 200, 200, 20)
+   */
+  function 点击随机范围(
+    区域左上角x坐标: 数字,
+    区域左上角y坐标: 数字,
+    区域右下角x坐标: 数字,
+    区域右下角y坐标: 数字,
+    按下持续时间?: 数字
+  ): 布尔值;
+  /**
+   * 双击
+   * @param 坐标x
+   * @param 坐标y
+   * @param 按下持续时间 默认20ms
+   * @param 间隔时间 默认20ms
+   * @param 抖动 开启抖动，会在像素范围随机偏移 点击 默认false
+   * @returns 双击是否成功
+   * @example $动作.双击(100, 100, 20, 20, true)
+   */
+  function 双击(
+    坐标x: 数字,
+    坐标y: 数字,
+    按下持续时间?: 数字,
+    间隔时间?: 数字,
+    抖动?: 布尔值
+  ): 布尔值;
+  /**
+   * 随机双击
+   * @param 区域左上角x坐标
+   * @param 区域左上角y坐标
+   * @param 区域右下角x坐标
+   * @param 区域右下角y坐标
+   * @param 按下持续时间 默认20ms
+   * @param 间隔时间 默认20ms
+   * @returns 随机双击是否成功
+   * @example $动作.双击随机范围(100, 100, 200, 200, 20, 20)
+   */
+  function 双击随机范围(
+    区域左上角x坐标: 数字,
+    区域左上角y坐标: 数字,
+    区域右下角x坐标: 数字,
+    区域右下角y坐标: 数字,
+    按下持续时间?: 数字,
+    间隔时间?: 数字
+  ): 布尔值;
+  /**
+   * 滑动
+   * @param 起始x坐标
+   * @param 起始y坐标
+   * @param 目标x坐标
+   * @param 目标y坐标
+   * @param 滑动持续时间 默认 100ms
+   * @param 抖动 开启抖动，会在像素范围随机偏移 滑动 默认false
+   * @param 步数 生成抖动点数量 默认6
+   * @returns 滑动是否成功
+   * @example $动作.滑动(100, 100, 200, 200, 500, true, 10)
+   */
+  function 滑动(
+    起始x坐标: 数字,
+    起始y坐标: 数字,
+    目标x坐标: 数字,
+    目标y坐标: 数字,
+    滑动持续时间?: 数字,
+    抖动?: 布尔值,
+    步数?: 数字
+  ): 布尔值;
+  /**
+   * 长按滑动
+   * @param 起始x坐标
+   * @param 起始y坐标
+   * @param 目标x坐标
+   * @param 目标y坐标
+   * @param 按下持续时间 默认500ms
+   * @param 移动持续时间 默认1000ms
+   * @param 松开持续时间 默认500ms
+   * @param 抖动 开启抖动，会在像素范围随机偏移 长按滑动 默认false
+   * @param 步数 生成抖动点数量 默认6
+   * @returns 长按滑动是否成功
+   * @example $动作.长按并滑动(100, 100, 200, 200, 500, 500, 500, true, 10)
+   */
+  function 长按并滑动(
+    起始x坐标: 数字,
+    起始y坐标: 数字,
+    目标x坐标: 数字,
+    目标y坐标: 数字,
+    按下持续时间?: 数字,
+    移动持续时间?: 数字,
+    松开持续时间?: 数字,
+    抖动?: 布尔值,
+    步数?: 数字
+  ): 布尔值;
+  /**
+   * 3点曲线滑动（先快后慢，拟人化轨迹）
+   * 使用二次贝塞尔曲线算法，添加随机偏移和时间抖动，模拟真实人手操作
+   * @param 起始x坐标
+   * @param 起始y坐标
+   * @param 中间点x坐标（控制曲线弯曲程度）
+   * @param 中间点y坐标（控制曲线弯曲程度）
+   * @param 目标x坐标
+   * @param 目标y坐标
+   * @param 滑动持续时间 总持续时间（毫秒），默认1000ms，实际执行时间会有随机变化
+   * @returns 曲线滑动是否成功
+   * @example $动作.曲线滑动(100, 100, 200, 150, 300, 200, 1000)
+   */
+  function 曲线滑动(
+    起始x坐标: 数字,
+    起始y坐标: 数字,
+    中间点x坐标: 数字,
+    中间点y坐标: 数字,
+    目标x坐标: 数字,
+    目标y坐标: 数字,
+    滑动持续时间?: 数字
+  ): 布尔值;
+  /**
+   * 输入文本
+   * @param text 文本内容
+   * @returns 输入文本是否成功
+   * @example $动作.输入文本("123456")
+   */
+  function 输入文本(文本: 字符串): 布尔值;
+  /**
+   * 删除文本
+   * @param 删除数量 默认为1
+   * @returns 删除文本是否成功
+   * @example $动作.删除文本(1)
+   */
+  function 删除文本(删除数量?: 数字): 布尔值;
+  /**
+   * 调用回车
+   * @returns 调用回车是否成功
+   * @example $动作.回车()
+   */
+  function 回车(): 布尔值;
+  /**
+   * 返回首页
+   * @returns 返回首页是否成功
+   * @example $动作.回到主页()
+   */
+  function 回到主页(): 布尔值;
+  /**
+   * 按下按钮
+   * @param 按键 按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键
+   * @returns 按下按钮是否成功
+   * @example $动作.按键("home")
+   */
+  function 按键(按键: "home" | "volumeup" | "volumedown"): 布尔值;
+  /**
+   * 模拟按下HID按钮
+   * @param 按键 HID按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键 power 按下电源键 snapshot 按下截图键
+   * @param 持续时间 持续时间 单位毫秒 默认20ms
+   * @returns 按下HID按钮是否成功
+   * @example $动作.按键HID("home", 200)
+   */
+  function 按键HID(
+    按键: "home" | "volumeup" | "volumedown" | "power" | "snapshot",
+    持续时间?: 数字
+  ): 布尔值;
+
+  /**
+   * 创建 动作构建器，支持链式调用构建复杂的多点触控动作
+   * @returns 动作构建器 实例
+   * @example const 动作构建器 = $动作.创建动作构建器()
+   */
+  function 创建动作构建器(): $动作构建器;
+
+  /**
+   * ActionBuilder 构建器接口
+   * 支持链式调用构建复杂的多点触控动作
+   */
+  interface $动作构建器 {
+    /**
+     * 添加一个指针（手指）
+     * @param id 指针编号，如 1-10
+     * @returns PointerBuilder 用于配置该指针的动作
+     * @example 动作构建器.添加手指(1).移动到(100, 100).点击(200, 200).完成()
+     */
+    添加手指(手指: 数字): $指针构建器;
+
+    /**
+     * 快速创建单点点击
+     * @param 坐标x
+     * @param 坐标y
+     * @param 持续时间 点击持续时间，如果未定义则默认为 20ms
+     * @returns 返回自身，支持链式调用
+     * @example 动作构建器.单指点击(100, 100, 50).执行()
+     */
+    单指点击(坐标x: 数字, 坐标y: 数字, 持续时间?: 数字): $指针构建器;
+
+    /**
+     * 快速创建多点点击
+     * @param points 点击坐标数组，每个元素包含 x 和 y 坐标
+     * @param duration 点击持续时间，如果未定义则默认为 20ms
+     * @returns 返回自身，支持链式调用
+     * @example 动作构建器.多指点击([{x: 100, y: 100}, {x: 200, y: 200}], 50).执行()
+     */
+    多指点击(
+      坐标数组: Array<{ x: 数字; y: 数字 }>,
+      持续时间?: 数字
+    ): $动作构建器;
+
+    /**
+     * 执行构建的动作
+     * @returns 执行是否成功
+     * @example const 是否成功 = 动作构建器.执行()
+     */
+    执行(): 布尔值;
+  }
+
+  /**
+   * 指针构建器接口
+   * 用于配置单个指针（手指）的动作序列
+   */
+  interface $指针构建器 {
+    /**
+     * 移动到指定坐标
+     * @param 坐标x
+     * @param 坐标y
+     * @param 持续时间 移动持续时间，如果未定义则默认为 0ms
+     * @returns 返回自身，支持链式调用
+     * @example 指针构建器.移动到(100, 100, 200)
+     */
+    移动到(坐标x: 数字, 坐标y: 数字, 持续时间?: 数字): $指针构建器;
+
+    /**
+     * 按下手指
+     * @returns 返回自身，支持链式调用
+     * @example 指针构建器.按下()
+     */
+    按下(): $指针构建器;
+
+    /**
+     * 抬起手指
+     * @returns 返回自身，支持链式调用
+     * @example 指针构建器.抬起()
+     */
+    抬起(): $指针构建器;
+
+    /**
+     * 延迟指定时间（暂停）
+     * @param 持续时间 延迟时间（毫秒），如果未定义则默认为 20ms
+     * @returns 返回自身，支持链式调用
+     * @example 指针构建器.停留(100)
+     */
+    停留(持续时间?: 数字): $指针构建器;
+
+    /**
+     * 执行点击动作（移动 -> 按下 -> 暂停 -> 抬起）
+     * @param 坐标x
+     * @param 坐标y
+     * @param 持续时间 按下持续时间，如果未定义则默认为 20ms
+     * @returns 返回自身，支持链式调用
+     * @example 指针构建器.点击(100, 100, 50)
+     */
+    点击(坐标x: 数字, 坐标y: 数字, 持续时间?: 数字): $指针构建器;
+
+    /**
+     * 完成当前指针配置，返回到主构建器
+     * @returns 返回 ActionBuilder，可以继续添加其他指针
+     * @example pointer.done().addPointer(2)
+     */
+    完成(): $动作构建器;
+  }
+}