ms-types 0.1.21 → 0.1.23

package/package.json

@@ -1,21 +1,21 @@
-{
-  "name": "ms-types",
-  "version": "0.1.21",
-  "type": "module",
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public"
-  },
-  "files": [
-    "types"
-  ],
-  "scripts": {
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
-  },
-  "devDependencies": {
-    "vitepress": "^1.6.4",
-    "vitepress-theme-teek": "^1.5.2"
-  }
+{
+  "name": "ms-types",
+  "version": "0.1.23",
+  "type": "module",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "types"
+  ],
+  "scripts": {
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  },
+  "devDependencies": {
+    "vitepress": "^1.6.4",
+    "vitepress-theme-teek": "^1.5.2"
+  }
 }

package/types/action.d.ts

@@ -1,298 +1,298 @@
-/**
- * 动作模块 包含点击、滑动、长按滑动、返回首页等动作
- */
-declare namespace action {
-  /**
-   * 设置动作抖动值 点击、滑动等动作会在像素范围-5到5随机偏移
-   * @param value 抖动值
-   * @example action.setJitterValue(5)
-   */
-  function setJitterValue(value: number): void;
-  /**
-   * 点击
-   * @param x 坐标x
-   * @param y 坐标y
-   * @param duration 持续时间 默认20ms
-   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 点击 默认false
-   * @returns 点击是否成功
-   * @example action.click(100, 100, 20, true)
-   */
-  function click(
-    x: number,
-    y: number,
-    duration?: number,
-    jitter?: boolean
-  ): boolean | Promise<boolean>;
-  /**
-   * 随机点击
-   * @param x1 区域左上角x坐标
-   * @param y1 区域左上角y坐标
-   * @param x2 区域右下角x坐标
-   * @param y2 区域右下角y坐标
-   * @param duration 持续时间 默认20ms
-   * @returns 随机点击是否成功
-   * @example action.clickRandom(100, 100, 200, 200, 20)
-   */
-  function clickRandom(
-    x1: number,
-    y1: number,
-    x2: number,
-    y2: number,
-    duration?: number
-  ): boolean | Promise<boolean>;
-  /**
-   * 双击
-   * @param x 坐标x
-   * @param y 坐标y
-   * @param duration 持续时间 默认20ms
-   * @param interval 双击间隔时间 默认20ms
-   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 点击 默认false
-   * @returns 双击是否成功
-   * @example action.doubleClick(100, 100, 20, 20, true)
-   */
-  function doubleClick(
-    x: number,
-    y: number,
-    duration?: number,
-    interval?: number,
-    jitter?: boolean
-  ): boolean | Promise<boolean>;
-  /**
-   * 随机双击
-   * @param x1 区域左上角x坐标
-   * @param y1 区域左上角y坐标
-   * @param x2 区域右下角x坐标
-   * @param y2 区域右下角y坐标
-   * @param duration 持续时间 默认20ms
-   * @param interval 双击间隔时间 默认20ms
-   * @returns 随机双击是否成功
-   * @example action.doubleClickRandom(100, 100, 200, 200, 20, 20)
-   */
-  function doubleClickRandom(
-    x1: number,
-    y1: number,
-    x2: number,
-    y2: number,
-    duration?: number,
-    interval?: number
-  ): boolean | Promise<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 | Promise<boolean>;
-  /**
-   * 长按滑动
-   * @param startX 起始坐标x
-   * @param startY 起始坐标y
-   * @param endX 结束坐标x
-   * @param endY 结束坐标y
-   * @param touch_down_duration 按下持续时间 默认500ms
-   * @param touch_move_duration 移动持续时间 默认1000ms
-   * @param touch_up_duration 松开持续时间 默认500ms
-   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 长按滑动 默认false
-   * @param steps 步数 生成抖动点数量 默认6
-   * @returns 长按滑动是否成功
-   * @example action.pressAndSwipe(100, 100, 200, 200, 500, 500, 500, true, 10)
-   */
-  function pressAndSwipe(
-    startX: number,
-    startY: number,
-    endX: number,
-    endY: number,
-    touch_down_duration?: number,
-    touch_move_duration?: number,
-    touch_up_duration?: number,
-    jitter?: boolean,
-    steps?: number
-  ): boolean | Promise<boolean>;
-  /**
-   * 3点曲线滑动（先快后慢，拟人化轨迹）
-   * 使用二次贝塞尔曲线算法，添加随机偏移和时间抖动，模拟真实人手操作
-   * @param startX 起始x坐标
-   * @param startY 起始y坐标
-   * @param midX 中间点x坐标（控制曲线弯曲程度）
-   * @param midY 中间点y坐标（控制曲线弯曲程度）
-   * @param endX 目标x坐标
-   * @param endY 目标y坐标
-   * @param duration 总持续时间（毫秒），默认1000ms，实际执行时间会有随机变化
-   * @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 | Promise<boolean>;
-  /**
-   * 输入文本
-   * @param text 文本内容
-   * @returns 输入文本是否成功
-   * @example action.input("123456")
-   */
-  function input(text: string): boolean | Promise<boolean>;
-  /**
-   * 删除文本
-   * @param count 删除数量 默认为1
-   * @returns 删除文本是否成功
-   * @example action.backspace(1)
-   */
-  function backspace(count?: number): boolean | Promise<boolean>;
-  /**
-   * 调用回车
-   * @returns 调用回车是否成功
-   * @example action.enter()
-   */
-  function enter(): boolean | Promise<boolean>;
-  /**
-   * 返回首页
-   * @returns 返回首页是否成功
-   * @example action.homeScreen()
-   */
-  function homeScreen(): boolean | Promise<boolean>;
-  /**
-   * 按下按钮
-   * @param button 按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键
-   * @returns 按下按钮是否成功
-   * @example action.pressButton("home")
-   */
-  function pressButton(
-    button: "home" | "volumeup" | "volumedown"
-  ): boolean | Promise<boolean>;
-  /**
-   * 模拟按下HID按钮
-   * @param button HID按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键 power 按下电源键 snapshot 按下截图键
-   * @param duration 持续时间 单位毫秒 默认20ms
-   * @returns 按下HID按钮是否成功
-   * @example action.pressHidButton("home", 200)
-   */
-  function pressHidButton(
-    button: "home" | "volumeup" | "volumedown" | "power" | "snapshot",
-    duration?: number
-  ): boolean | Promise<boolean>;
-
-  /**
-   * 创建 ActionBuilder 构建器，支持链式调用构建复杂的多点触控动作
-   * @returns ActionBuilder 实例
-   * @example const builder = action.createBuilder()
-   */
-  function createBuilder(): ActionBuilder;
-
-  /**
-   * ActionBuilder 构建器接口
-   * 支持链式调用构建复杂的多点触控动作
-   */
-  interface ActionBuilder {
-    /**
-     * 添加一个指针（手指）
-     * @param id 指针编号，如 1-10
-     * @returns PointerBuilder 用于配置该指针的动作
-     * @example builder.addPointer(1).moveTo(100, 100).tap(200, 200).done()
-     */
-    addPointer(id: number): PointerBuilder;
-
-    /**
-     * 快速创建单点点击
-     * @param x X 坐标
-     * @param y Y 坐标
-     * @param duration 点击持续时间，如果未定义则默认为 20ms
-     * @returns 返回自身，支持链式调用
-     * @example builder.singleTap(100, 100, 50).execute()
-     */
-    singleTap(x: number, y: number, duration?: number): ActionBuilder;
-
-    /**
-     * 快速创建多点点击
-     * @param points 点击坐标数组，每个元素包含 x 和 y 坐标
-     * @param duration 点击持续时间，如果未定义则默认为 20ms
-     * @returns 返回自身，支持链式调用
-     * @example builder.multiTap([{x: 100, y: 100}, {x: 200, y: 200}], 50).execute()
-     */
-    multiTap(
-      points: { x: number; y: number }[],
-      duration?: number
-    ): ActionBuilder;
-
-    /**
-     * 执行构建的动作
-     * @returns 执行是否成功
-     * @example const success = builder.execute()
-     */
-    execute(): boolean | Promise<boolean>;
-  }
-
-  /**
-   * 指针构建器接口
-   * 用于配置单个指针（手指）的动作序列
-   */
-  interface PointerBuilder {
-    /**
-     * 移动到指定坐标
-     * @param x X 坐标
-     * @param y Y 坐标
-     * @param duration 移动持续时间，如果未定义则默认为 0ms
-     * @returns 返回自身，支持链式调用
-     * @example pointer.moveTo(100, 100, 200)
-     */
-    moveTo(x: number, y: number, duration?: number): PointerBuilder;
-
-    /**
-     * 按下手指
-     * @returns 返回自身，支持链式调用
-     * @example pointer.down()
-     */
-    down(): PointerBuilder;
-
-    /**
-     * 抬起手指
-     * @returns 返回自身，支持链式调用
-     * @example pointer.up()
-     */
-    up(): PointerBuilder;
-
-    /**
-     * 延迟指定时间（暂停）
-     * @param duration 延迟时间（毫秒），如果未定义则默认为 20ms
-     * @returns 返回自身，支持链式调用
-     * @example pointer.stay(100)
-     */
-    stay(duration?: number): PointerBuilder;
-
-    /**
-     * 执行点击动作（移动 -> 按下 -> 暂停 -> 抬起）
-     * @param x X 坐标
-     * @param y Y 坐标
-     * @param duration 按下持续时间，如果未定义则默认为 20ms
-     * @returns 返回自身，支持链式调用
-     * @example pointer.tap(100, 100, 50)
-     */
-    tap(x: number, y: number, duration?: number): PointerBuilder;
-
-    /**
-     * 完成当前指针配置，返回到主构建器
-     * @returns 返回 ActionBuilder，可以继续添加其他指针
-     * @example pointer.done().addPointer(2)
-     */
-    done(): ActionBuilder;
-  }
-}
+/**
+ * 动作模块 包含点击、滑动、长按滑动、返回首页等动作
+ */
+declare namespace action {
+  /**
+   * 设置动作抖动值 点击、滑动等动作会在像素范围-5到5随机偏移
+   * @param value 抖动值
+   * @example action.setJitterValue(5)
+   */
+  function setJitterValue(value: number): void;
+  /**
+   * 点击
+   * @param x 坐标x
+   * @param y 坐标y
+   * @param duration 持续时间 默认20ms
+   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 点击 默认false
+   * @returns 点击是否成功
+   * @example action.click(100, 100, 20, true)
+   */
+  function click(
+    x: number,
+    y: number,
+    duration?: number,
+    jitter?: boolean
+  ): boolean | Promise<boolean>;
+  /**
+   * 随机点击
+   * @param x1 区域左上角x坐标
+   * @param y1 区域左上角y坐标
+   * @param x2 区域右下角x坐标
+   * @param y2 区域右下角y坐标
+   * @param duration 持续时间 默认20ms
+   * @returns 随机点击是否成功
+   * @example action.clickRandom(100, 100, 200, 200, 20)
+   */
+  function clickRandom(
+    x1: number,
+    y1: number,
+    x2: number,
+    y2: number,
+    duration?: number
+  ): boolean | Promise<boolean>;
+  /**
+   * 双击
+   * @param x 坐标x
+   * @param y 坐标y
+   * @param duration 持续时间 默认20ms
+   * @param interval 双击间隔时间 默认20ms
+   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 点击 默认false
+   * @returns 双击是否成功
+   * @example action.doubleClick(100, 100, 20, 20, true)
+   */
+  function doubleClick(
+    x: number,
+    y: number,
+    duration?: number,
+    interval?: number,
+    jitter?: boolean
+  ): boolean | Promise<boolean>;
+  /**
+   * 随机双击
+   * @param x1 区域左上角x坐标
+   * @param y1 区域左上角y坐标
+   * @param x2 区域右下角x坐标
+   * @param y2 区域右下角y坐标
+   * @param duration 持续时间 默认20ms
+   * @param interval 双击间隔时间 默认20ms
+   * @returns 随机双击是否成功
+   * @example action.doubleClickRandom(100, 100, 200, 200, 20, 20)
+   */
+  function doubleClickRandom(
+    x1: number,
+    y1: number,
+    x2: number,
+    y2: number,
+    duration?: number,
+    interval?: number
+  ): boolean | Promise<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 | Promise<boolean>;
+  /**
+   * 长按滑动
+   * @param startX 起始坐标x
+   * @param startY 起始坐标y
+   * @param endX 结束坐标x
+   * @param endY 结束坐标y
+   * @param touch_down_duration 按下持续时间 默认500ms
+   * @param touch_move_duration 移动持续时间 默认1000ms
+   * @param touch_up_duration 松开持续时间 默认500ms
+   * @param jitter 抖动 开启抖动，会在像素范围随机偏移 长按滑动 默认false
+   * @param steps 步数 生成抖动点数量 默认6
+   * @returns 长按滑动是否成功
+   * @example action.pressAndSwipe(100, 100, 200, 200, 500, 500, 500, true, 10)
+   */
+  function pressAndSwipe(
+    startX: number,
+    startY: number,
+    endX: number,
+    endY: number,
+    touch_down_duration?: number,
+    touch_move_duration?: number,
+    touch_up_duration?: number,
+    jitter?: boolean,
+    steps?: number
+  ): boolean | Promise<boolean>;
+  /**
+   * 3点曲线滑动（先快后慢，拟人化轨迹）
+   * 使用二次贝塞尔曲线算法，添加随机偏移和时间抖动，模拟真实人手操作
+   * @param startX 起始x坐标
+   * @param startY 起始y坐标
+   * @param midX 中间点x坐标（控制曲线弯曲程度）
+   * @param midY 中间点y坐标（控制曲线弯曲程度）
+   * @param endX 目标x坐标
+   * @param endY 目标y坐标
+   * @param duration 总持续时间（毫秒），默认1000ms，实际执行时间会有随机变化
+   * @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 | Promise<boolean>;
+  /**
+   * 输入文本
+   * @param text 文本内容
+   * @returns 输入文本是否成功
+   * @example action.input("123456")
+   */
+  function input(text: string): boolean | Promise<boolean>;
+  /**
+   * 删除文本
+   * @param count 删除数量 默认为1
+   * @returns 删除文本是否成功
+   * @example action.backspace(1)
+   */
+  function backspace(count?: number): boolean | Promise<boolean>;
+  /**
+   * 调用回车
+   * @returns 调用回车是否成功
+   * @example action.enter()
+   */
+  function enter(): boolean | Promise<boolean>;
+  /**
+   * 返回首页
+   * @returns 返回首页是否成功
+   * @example action.homeScreen()
+   */
+  function homeScreen(): boolean | Promise<boolean>;
+  /**
+   * 按下按钮
+   * @param button 按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键
+   * @returns 按下按钮是否成功
+   * @example action.pressButton("home")
+   */
+  function pressButton(
+    button: "home" | "volumeup" | "volumedown"
+  ): boolean | Promise<boolean>;
+  /**
+   * 模拟按下HID按钮
+   * @param button HID按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键 power 按下电源键 snapshot 按下截图键
+   * @param duration 持续时间 单位毫秒 默认20ms
+   * @returns 按下HID按钮是否成功
+   * @example action.pressHidButton("home", 200)
+   */
+  function pressHidButton(
+    button: "home" | "volumeup" | "volumedown" | "power" | "snapshot",
+    duration?: number
+  ): boolean | Promise<boolean>;
+
+  /**
+   * 创建 ActionBuilder 构建器，支持链式调用构建复杂的多点触控动作
+   * @returns ActionBuilder 实例
+   * @example const builder = action.createBuilder()
+   */
+  function createBuilder(): ActionBuilder;
+
+  /**
+   * ActionBuilder 构建器接口
+   * 支持链式调用构建复杂的多点触控动作
+   */
+  interface ActionBuilder {
+    /**
+     * 添加一个指针（手指）
+     * @param id 指针编号，如 1-10
+     * @returns PointerBuilder 用于配置该指针的动作
+     * @example builder.addPointer(1).moveTo(100, 100).tap(200, 200).done()
+     */
+    addPointer(id: number): PointerBuilder;
+
+    /**
+     * 快速创建单点点击
+     * @param x X 坐标
+     * @param y Y 坐标
+     * @param duration 点击持续时间，如果未定义则默认为 20ms
+     * @returns 返回自身，支持链式调用
+     * @example builder.singleTap(100, 100, 50).execute()
+     */
+    singleTap(x: number, y: number, duration?: number): ActionBuilder;
+
+    /**
+     * 快速创建多点点击
+     * @param points 点击坐标数组，每个元素包含 x 和 y 坐标
+     * @param duration 点击持续时间，如果未定义则默认为 20ms
+     * @returns 返回自身，支持链式调用
+     * @example builder.multiTap([{x: 100, y: 100}, {x: 200, y: 200}], 50).execute()
+     */
+    multiTap(
+      points: { x: number; y: number }[],
+      duration?: number
+    ): ActionBuilder;
+
+    /**
+     * 执行构建的动作
+     * @returns 执行是否成功
+     * @example const success = builder.execute()
+     */
+    execute(): boolean | Promise<boolean>;
+  }
+
+  /**
+   * 指针构建器接口
+   * 用于配置单个指针（手指）的动作序列
+   */
+  interface PointerBuilder {
+    /**
+     * 移动到指定坐标
+     * @param x X 坐标
+     * @param y Y 坐标
+     * @param duration 移动持续时间，如果未定义则默认为 0ms
+     * @returns 返回自身，支持链式调用
+     * @example pointer.moveTo(100, 100, 200)
+     */
+    moveTo(x: number, y: number, duration?: number): PointerBuilder;
+
+    /**
+     * 按下手指
+     * @returns 返回自身，支持链式调用
+     * @example pointer.down()
+     */
+    down(): PointerBuilder;
+
+    /**
+     * 抬起手指
+     * @returns 返回自身，支持链式调用
+     * @example pointer.up()
+     */
+    up(): PointerBuilder;
+
+    /**
+     * 延迟指定时间（暂停）
+     * @param duration 延迟时间（毫秒），如果未定义则默认为 20ms
+     * @returns 返回自身，支持链式调用
+     * @example pointer.stay(100)
+     */
+    stay(duration?: number): PointerBuilder;
+
+    /**
+     * 执行点击动作（移动 -> 按下 -> 暂停 -> 抬起）
+     * @param x X 坐标
+     * @param y Y 坐标
+     * @param duration 按下持续时间，如果未定义则默认为 20ms
+     * @returns 返回自身，支持链式调用
+     * @example pointer.tap(100, 100, 50)
+     */
+    tap(x: number, y: number, duration?: number): PointerBuilder;
+
+    /**
+     * 完成当前指针配置，返回到主构建器
+     * @returns 返回 ActionBuilder，可以继续添加其他指针
+     * @example pointer.done().addPointer(2)
+     */
+    done(): ActionBuilder;
+  }
+}