ms-types 0.4.26 → 0.4.28

package/types/hid.d.ts

@@ -1,338 +1,357 @@
-declare const hidKey: {
-  COMMAND: number;
-  LEFT_CTRL: number;
-  LEFT_SHIFT: number;
-  LEFT_ALT: number;
-  RIGHT_CTRL: number;
-  RIGHT_SHIFT: number;
-  RIGHT_ALT: number;
-  UP_ARROW: number;
-  DOWN_ARROW: number;
-  LEFT_ARROW: number;
-  RIGHT_ARROW: number;
-  SPACE: number;
-  BACKSPACE: number;
-  TAB: number;
-  RETURN: number;
-  ESC: number;
-  INSERT: number;
-  DELETE: number;
-  PAGE_UP: number;
-  PAGE_DOWN: number;
-  HOME: number;
-  END: number;
-  CAPS_LOCK: number;
-  F1: number;
-  F2: number;
-  F3: number;
-  F4: number;
-  F5: number;
-  F6: number;
-  F7: number;
-  F8: number;
-  F9: number;
-  F10: number;
-  F11: number;
-  F12: number;
-};
-
-/**
- * HID模块 包含点击、滑动、长按滑动、返回首页等动作
- */
-declare namespace hid {
-  /**
-   * 打开录屏界面
-   */
-  function openRecordScreen(): void;
-
-  /**
-   * 检查录屏是否开启
-   * @returns 是否开启
-   */
-  function isRecording(): boolean;
-
-  /**
-   * 设置动作抖动值
-   * @param value 抖动值
-   */
-  function setJitterValue(value: number): void;
-
-  /**
-   * 重置坐标
-   * @param orientation 屏幕方向 可选值为"PORTRAIT"和"LANDSCAPE"
-   */
-  function resetPosition(orientation?: "PORTRAIT" | "LANDSCAPE"): void;
-
-  /**
-   * 移动指定坐标
-   * @param x 移动坐标的X轴
-   * @param y 移动坐标的Y轴
-   * @returns 操作是否成功
-   */
-  function move(x: number, y: number): boolean;
-
-  /**
-   * 点击指定坐标
-   * @param x 点击坐标的X轴
-   * @param y 点击坐标的Y轴
-   * @param duration 点击持续时间（可选，默认值为10毫秒）
-   * @param jitter 是否添加随机抖动（可选，默认值为false）
-   * @returns 操作是否成功
-   */
-  function click(
-    x: number,
-    y: number,
-    duration?: number,
-    jitter?: boolean,
-  ): 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;
-  /**
-   * 双击
-   * @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;
-  /**
-   * 随机双击
-   * @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;
-
-  /**
-   * 滑动指定坐标
-   * @param x 滑动起始坐标的X轴
-   * @param y 滑动起始坐标的Y轴
-   * @param ex 滑动目标坐标的X轴
-   * @param ey 滑动目标坐标的Y轴
-   * @param jitter 是否添加随机抖动（可选，默认值为false）
-   * @param steps 滑动步骤数（可选，默认值为6）
-   * @returns 操作是否成功
-   */
-  function swipe(
-    x: number,
-    y: number,
-    ex: number,
-    ey: number,
-    jitter?: boolean,
-    steps?: number,
-  ): boolean;
-
-  /**
-   * 长按滑动
-   * @param startX 起始x坐标
-   * @param startY 起始y坐标
-   * @param endX 目标x坐标
-   * @param endY 目标y坐标
-   * @param duration 长按持续时间 默认500ms
-   * @param jitter 是否添加随机抖动（可选，默认值为false）
-   * @param steps 滑动步骤数（可选，默认值为6）
-   * @returns 操作是否成功
-   */
-  function pressAndSwipe(
-    startX: number,
-    startY: number,
-    endX: number,
-    endY: number,
-    duration?: number,
-    jitter?: boolean,
-    steps?: number,
-  ): boolean;
-
-  /**
-   * 3点曲线滑动（先快后慢）
-   * @param startX 起始x坐标
-   * @param startY 起始y坐标
-   * @param midX 中间点x坐标
-   * @param midY 中间点y坐标
-   * @param endX 目标x坐标
-   * @param endY 目标y坐标
-   * @returns 操作是否成功
-   */
-  function swipeCurve(
-    startX: number,
-    startY: number,
-    midX: number,
-    midY: number,
-    endX: number,
-    endY: number,
-  ): boolean;
-
-  /**
-   * 返回首页
-   * @returns 操作是否成功
-   */
-  function homeScreen(): boolean;
-
-  /**
-   * 输入文本
-   * @param text 要输入的文本
-   * @returns 操作是否成功
-   */
-  function input(text: string): boolean;
-
-  /**
-   * 空格（Space）
-   * @returns 操作是否成功
-   */
-  function space(): boolean;
-
-  /**
-   * 删除键（Backspace）
-   * @param count 删除次数（可选，默认值为1）
-   * @returns 操作是否成功
-   */
-  function backspace(count?: number): boolean;
-
-  /**
-   * 回车键（Return）
-   * @returns 操作是否成功
-   */
-  function enter(): boolean;
-
-  /**
-   * 发送组合按键
-   * @param key 要发送的按键
-   * @returns 操作是否成功
-   */
-  function sendKey(key: Array<number | string>): boolean;
-
-  /**
-   * 按下按钮
-   * @param button 按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键
-   * @returns 按下按钮是否成功
-   * @example action.pressButton("home")
-   */
-  function pressButton(button: "home" | "volumeup" | "volumedown"): boolean;
-
-  /**
-   * 复制文本（Command+C）
-   * @returns 操作是否成功
-   */
-  function copyText(): boolean;
-
-  /**
-   * 粘贴文本（Command+V）
-   * @returns 操作是否成功
-   */
-  function pasteText(): boolean;
-
-  /**
-   * 返回（Tab+B)
-   * @returns 操作是否成功
-   */
-  function back(): boolean;
-
-  /**
-   * APP 切换器
-   * @returns 操作是否成功
-   */
-  function recent(): boolean;
-
-  /**
-   * 锁屏
-   * @returns 操作是否成功
-   */
-  function lock(): boolean;
-
-  /**
-   * 解锁
-   * @returns 操作是否成功
-   */
-  function unlock(): boolean;
-
-  /**
-   * 打开URL
-   * @param url URL字符串
-   * @returns 操作是否成功
-   */
-  function openURL(url: string): boolean;
-
-  /**
-   * 打开 app
-   * @param name 应用名称
-   * @returns 操作是否成功
-   */
-  function openApp(name: string): boolean;
-
-  /**
-   * 切换到前台
-   * @returns 操作是否成功
-   */
-  function takeMeToFront(): boolean;
-
-  /**
-   * 获取当前打开应用信息（仅 IOS18.6+）
-   * @returns 当前打开应用信息
-   */
-  function currentAppInfo(): {
-    /**
-     * 应用名称
-     */
-    name: string;
-    /**
-     * 应用Bundle ID
-     */
-    bundleId: string;
-  } | null;
-
-  /**
-   * 设置剪切板内容
-   * @param text 要设置的文本
-   * @returns 设置结果
-   */
-  function setClipboard(text: string): boolean;
-
-  /**
-   * 获取剪切板内容
-   * @returns 剪切板内容
-   */
-  function getClipboard(): string;
-
-  /**
-   * 执行自定义按钮
-   * @param button 自定义按钮 5-11 对应 自定义快捷键 5-11
-   * @returns 操作是否成功
-   */
-  function customButton(button: number): boolean;
-}
+declare const hidKey: {
+  COMMAND: number;
+  LEFT_CTRL: number;
+  LEFT_SHIFT: number;
+  LEFT_ALT: number;
+  RIGHT_CTRL: number;
+  RIGHT_SHIFT: number;
+  RIGHT_ALT: number;
+  UP_ARROW: number;
+  DOWN_ARROW: number;
+  LEFT_ARROW: number;
+  RIGHT_ARROW: number;
+  SPACE: number;
+  BACKSPACE: number;
+  TAB: number;
+  RETURN: number;
+  ESC: number;
+  INSERT: number;
+  DELETE: number;
+  PAGE_UP: number;
+  PAGE_DOWN: number;
+  HOME: number;
+  END: number;
+  CAPS_LOCK: number;
+  F1: number;
+  F2: number;
+  F3: number;
+  F4: number;
+  F5: number;
+  F6: number;
+  F7: number;
+  F8: number;
+  F9: number;
+  F10: number;
+  F11: number;
+  F12: number;
+};
+
+/**
+ * HID模块 包含点击、滑动、长按滑动、返回首页等动作
+ */
+declare namespace hid {
+  /**
+   * 打开录屏界面
+   */
+  function openRecordScreen(): void;
+
+  /**
+   * 检查录屏是否开启
+   * @returns 是否开启
+   */
+  function isRecording(): boolean;
+
+  /**
+   * 检查是否连接了蓝牙HID设备
+   * @returns 是否连接了蓝牙HID设备
+   */
+  function isBLEConnected(): boolean;
+
+  /**
+   * 检查是否连接了USB HID设备
+   * @returns 是否连接了USB HID设备
+   */
+  function isUSBConnected(): boolean;
+
+  /**
+   * 设置动作抖动值
+   * @param value 抖动值
+   */
+  function setJitterValue(value: number): void;
+
+  /**
+   * 重置坐标
+   * @param orientation 屏幕方向 可选值为"PORTRAIT"和"LANDSCAPE"
+   */
+  function resetPosition(orientation?: "PORTRAIT" | "LANDSCAPE"): void;
+
+  /**
+   * 移动指定坐标
+   * @param x 移动坐标的X轴
+   * @param y 移动坐标的Y轴
+   * @returns 操作是否成功
+   */
+  function move(x: number, y: number): boolean;
+
+  /**
+   * 点击指定坐标
+   * @param x 点击坐标的X轴
+   * @param y 点击坐标的Y轴
+   * @param duration 点击持续时间（可选，默认值为10毫秒）
+   * @param jitter 是否添加随机抖动（可选，默认值为false）
+   * @returns 操作是否成功
+   */
+  function click(
+    x: number,
+    y: number,
+    duration?: number,
+    jitter?: boolean,
+  ): 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;
+  /**
+   * 双击
+   * @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;
+  /**
+   * 随机双击
+   * @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;
+
+  /**
+   * 滑动指定坐标
+   * @param x 滑动起始坐标的X轴
+   * @param y 滑动起始坐标的Y轴
+   * @param ex 滑动目标坐标的X轴
+   * @param ey 滑动目标坐标的Y轴
+   * @param jitter 是否添加随机抖动（可选，默认值为false）
+   * @param steps 滑动步骤数（可选，默认值为6）
+   * @returns 操作是否成功
+   */
+  function swipe(
+    x: number,
+    y: number,
+    ex: number,
+    ey: number,
+    jitter?: boolean,
+    steps?: number,
+  ): boolean;
+
+  /**
+   * 长按滑动
+   * @param startX 起始x坐标
+   * @param startY 起始y坐标
+   * @param endX 目标x坐标
+   * @param endY 目标y坐标
+   * @param duration 长按持续时间 默认500ms
+   * @param jitter 是否添加随机抖动（可选，默认值为false）
+   * @param steps 滑动步骤数（可选，默认值为6）
+   * @returns 操作是否成功
+   */
+  function pressAndSwipe(
+    startX: number,
+    startY: number,
+    endX: number,
+    endY: number,
+    duration?: number,
+    jitter?: boolean,
+    steps?: number,
+  ): boolean;
+
+  /**
+   * 3点曲线滑动（先快后慢）
+   * @param startX 起始x坐标
+   * @param startY 起始y坐标
+   * @param midX 中间点x坐标
+   * @param midY 中间点y坐标
+   * @param endX 目标x坐标
+   * @param endY 目标y坐标
+   * @returns 操作是否成功
+   */
+  function swipeCurve(
+    startX: number,
+    startY: number,
+    midX: number,
+    midY: number,
+    endX: number,
+    endY: number,
+  ): boolean;
+
+  /**
+   * 返回首页
+   * @returns 操作是否成功
+   */
+  function homeScreen(): boolean;
+
+  /**
+   * 输入文本
+   * @param text 要输入的文本
+   * @returns 操作是否成功
+   */
+  function input(text: string): boolean;
+
+  /**
+   * 空格（Space）
+   * @returns 操作是否成功
+   */
+  function space(): boolean;
+
+  /**
+   * 删除键（Backspace）
+   * @param count 删除次数（可选，默认值为1）
+   * @returns 操作是否成功
+   */
+  function backspace(count?: number): boolean;
+
+  /**
+   * 回车键（Return）
+   * @returns 操作是否成功
+   */
+  function enter(): boolean;
+
+  /**
+   * 发送组合按键
+   * @param key 要发送的按键
+   * @returns 操作是否成功
+   */
+  function sendKey(key: Array<number | string>): boolean;
+
+  /**
+   * 按下按钮
+   * @param button 按钮 home 按下home键 volumeup 按下音量上键 volumedown 按下音量下键
+   * @returns 按下按钮是否成功
+   * @example action.pressButton("home")
+   */
+  function pressButton(button: "home" | "volumeup" | "volumedown"): boolean;
+
+  /**
+   * 复制文本（Command+C）
+   * @returns 操作是否成功
+   */
+  function copyText(): boolean;
+
+  /**
+   * 粘贴文本（Command+V）
+   * @returns 操作是否成功
+   */
+  function pasteText(): boolean;
+
+  /**
+   * 返回（Tab+B)
+   * @returns 操作是否成功
+   */
+  function back(): boolean;
+
+  /**
+   * APP 切换器
+   * @returns 操作是否成功
+   */
+  function recent(): boolean;
+
+  /**
+   * 锁屏
+   * @returns 操作是否成功
+   */
+  function lock(): boolean;
+
+  /**
+   * 解锁
+   * @returns 操作是否成功
+   */
+  function unlock(): boolean;
+
+  /**
+   * 打开URL
+   * @param url URL字符串
+   * @returns 操作是否成功
+   */
+  function openURL(url: string): boolean;
+
+  /**
+   * 打开 app
+   * @param name 应用名称 支持 app name 或 bundleId
+   * @returns 操作是否成功
+   */
+  function openApp(name: string): boolean;
+
+  /**
+   * 关闭 app
+   * @param name 应用名称 支持 app name 或 bundleId
+   * @returns 操作是否成功
+   */
+  function closeApp(name: string): boolean;
+
+  /**
+   * 切换到前台
+   * @returns 操作是否成功
+   */
+  function takeMeToFront(): boolean;
+
+  /**
+   * 获取当前打开应用信息（仅 IOS18.6+）
+   * @returns 当前打开应用信息
+   */
+  function currentAppInfo(): {
+    /**
+     * 应用名称
+     */
+    name: string;
+    /**
+     * 应用Bundle ID
+     */
+    bundleId: string;
+  } | null;
+
+  /**
+   * 设置剪切板内容
+   * @param text 要设置的文本
+   * @returns 设置结果
+   */
+  function setClipboard(text: string): boolean;
+
+  /**
+   * 获取剪切板内容
+   * @returns 剪切板内容
+   */
+  function getClipboard(): string;
+
+  /**
+   * 执行自定义按钮
+   * @param button 自定义按钮 5-11 对应 自定义快捷键 5-11
+   * @returns 操作是否成功
+   */
+  function customButton(button: number): boolean;
+}