ms-types 0.1.10 → 0.1.14

package/package.json

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

package/types/appleOcr.d.ts

@@ -31,10 +31,10 @@ declare namespace appleOcr {
   /**
    * 执行OCR识别（使用Apple Vision框架）
    * @param input 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
-   * @param x 边界框左上角x坐标
-   * @param y 边界框左上角y坐标
-   * @param ex 边界框右下角x坐标
-   * @param ey 边界框右下角y坐标
+   * @param x 边界框左上角x坐标 默认 0
+   * @param y 边界框左上角y坐标 默认 0
+   * @param ex 边界框右下角x坐标 默认 0
+   * @param ey 边界框右下角y坐标 默认 0
    * @param languages 识别语言数组，默认为["zh-Hans", "en-US"]
    * @returns 识别结果数组，包含文本、置信度、坐标等信息
    * @example

package/types/config.d.ts

@@ -19,10 +19,10 @@ declare namespace config {
   /**
    * 读取配置String
    * @param key 配置key
-   * @returns 配置值
+   * @returns 配置值，如果不存在返回 null
    * @example config.readConfigString("key")
    */
-  function readConfigString(key: string): string;
+  function readConfigString(key: string): string | null;
   /**
    * 读取配置Bool
    * @param key 配置key

package/types/file.d.ts

@@ -48,10 +48,10 @@ declare namespace file {
   /**
    * 读取文件内容
    * @param path 文件路径
-   * @returns 文件内容
+   * @returns 文件内容，如果读取失败返回 null
    * @example file.readFile("config.json")
    */
-  function readFile(path: string): string;
+  function readFile(path: string): string | null;
   /**
    * 读取资源文件
    * @param fileName 文件名
@@ -97,17 +97,17 @@ declare namespace file {
    * 读取文件第N行内容
    * @param path 文件路径
    * @param lineNo 行号
-   * @returns 行内容
+   * @returns 行内容，如果读取失败返回 null
    * @example file.readLine("config.json", 1)
    */
-  function readLine(path: string, lineNo: number): string;
+  function readLine(path: string, lineNo: number): string | null;
   /**
    * 读取文件所有行内容
    * @param path 文件路径
-   * @returns 行内容数组
+   * @returns 行内容数组，如果读取失败返回 null
    * @example file.readAllLines("config.json")
    */
-  function readAllLines(path: string): string[];
+  function readAllLines(path: string): string[] | null;
   /**
    * 文件或者文件夹是否存在
    * @param path 文件路径

package/types/global.d.ts

@@ -67,7 +67,7 @@ declare const __package__: {
  *   logi("脚本执行完成");
  * });
  */
-declare function setStopCallback(callback: Function): void;
+declare function setStopCallback(callback: () => void): void;
 
 /**
  * 设置异常停止回调（仅主线程调用）

package/types/http.d.ts

@@ -115,7 +115,7 @@ declare namespace http {
      * 响应体
      */
     body: string;
-  };
+  } | null;
 
   /**
    * 下载文件 支持断点续传
@@ -149,7 +149,7 @@ declare namespace http {
     params?: Record<string, string>,
     timeout?: number,
     headers?: Record<string, string>
-  ): string;
+  ): string | null;
 
   /**
    * 发送POST请求
@@ -168,7 +168,7 @@ declare namespace http {
     files?: Record<string, string>,
     timeout?: number,
     headers?: Record<string, string>
-  ): string;
+  ): string | null;
 
   /**
    * 发送JSON请求
@@ -185,10 +185,10 @@ declare namespace http {
    */
   function postJSON(
     url: string,
-    json?: Record<string, string>,
+    json?: Record<string, any>,
     timeout?: number,
     headers?: Record<string, string>
-  ): string;
+  ): string | null;
 
   /**
    * 创建WebSocket连接

package/types/image.d.ts

@@ -38,7 +38,7 @@ declare namespace image {
    * @example
    * image.saveTo(imageId, "screen.jpg")
    */
-  function saveTo(imageId: string, filePath: string): void;
+  function saveTo(imageId: string, filePath: string): boolean;
   /**
    * 图片是否已释放
    * @param imageId 图片id
@@ -266,7 +266,7 @@ declare namespace image {
     y: number,
     ex: number,
     ey: number
-  ): string;
+  ): string | null;
   /**
    * 获取图片像素
    * @param imageId 图片id
@@ -310,7 +310,7 @@ declare namespace image {
    * }
    * image.release(imageId)
    */
-  function binaryzation(imageId: string, threshold: number): string;
+  function binaryzation(imageId: string, threshold: number): string | null;
   /**
    * 灰度化
    * @param imageId 图片id
@@ -325,7 +325,7 @@ declare namespace image {
    * }
    * image.release(imageId)
    */
-  function gray(imageId: string): string;
+  function gray(imageId: string): string | null;
   /**
    * base64转图片
    * @param base64 base64字符串
@@ -337,7 +337,7 @@ declare namespace image {
    * }
    * image.release(imageId)
    */
-  function base64ToImage(base64: string): string;
+  function base64ToImage(base64: string): string | null;
   /**
    * 图片转base64
    * @param imageId 图片id
@@ -352,7 +352,7 @@ declare namespace image {
    * }
    * image.release(imageId)
    */
-  function toBase64Format(imageId: string, format: string, q: number): string;
+  function toBase64Format(imageId: string, format: string, q: number): string | null;
   /**
    * 扫描条码 支持一维码和二维码
    * @param imageId 图片id

package/types/pip.d.ts

@@ -45,6 +45,7 @@ declare namespace pip {
   /**
    * 设置是否允许悬浮窗控制脚本启停
    * @param ctrl true代表允许，false代表不允许
+   * @returns true代表成功，false代表失败
    */
-  function setPipCtrlScript(ctrl: boolean): void;
+  function setPipCtrlScript(ctrl: boolean): boolean;
 }

package/types/thread.d.ts

@@ -27,7 +27,7 @@ declare namespace thread {
     threadJsFile: string,
     callbackName: string,
     callbackFunc: (data?: any) => any
-  ): String | null;
+  ): string | null;
   /**
    * 调用线程回调函数
    * @param name 回调函数名称
@@ -62,7 +62,7 @@ declare namespace thread {
      */
     addCallback: (
       callbackName: string,
-      callbackFunc: (data?: any) => void
+      callbackFunc: (data?: any) => any
     ) => boolean;
   } | null;
   /**

package/types/zh/HID/346/250/241/345/235/227.d.ts

@@ -204,13 +204,13 @@ declare namespace $HID {
    * 复制文本（Command+C）
    * @returns 操作是否成功
    */
-  function 复制文本(): 布尔值;
+  function 复制(): 布尔值;
 
   /**
    * 粘贴文本（Command+V）
    * @returns 操作是否成功
    */
-  function 粘贴文本(): 布尔值;
+  function 粘贴(): 布尔值;
 
   /**
    * 返回（Tab+B)

package/types/zh/HTTP/346/250/241/345/235/227.d.ts

@@ -116,7 +116,7 @@ declare namespace $HTTP {
      * 响应体
      */
     body: 字符串;
-  };
+  } | null;
 
   /**
    * 下载文件 支持断点续传
@@ -150,7 +150,7 @@ declare namespace $HTTP {
     请求参数?: 字典<字符串>,
     超时时间?: 数字,
     请求头?: 字典<字符串>
-  ): 字符串;
+  ): 字符串 | null;
 
   /**
    * 发送POST请求
@@ -165,11 +165,11 @@ declare namespace $HTTP {
    */
   function 发送POST请求(
     请求地址: 字符串,
-    请求参数?: 字典<字符串>,
+    请求参数?: 字典<任意类型>,
     请求文件?: 字典<字符串>,
     超时时间?: 数字,
     请求头?: 字典<字符串>
-  ): 字符串;
+  ): 字符串 | null;
 
   /**
    * 发送JSON请求
@@ -189,7 +189,7 @@ declare namespace $HTTP {
     请求JSON数据?: 字典<任意类型>,
     超时时间?: 数字,
     请求头?: 字典<字符串>
-  ): 字符串;
+  ): 字符串 | null;
 
   /**
    * 创建WebSocket连接

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

@@ -215,11 +215,11 @@ declare namespace $动作 {
      * 快速创建单点点击
      * @param 坐标x
      * @param 坐标y
-     * @param 持续时间 点击持续时间，如果未定义则默认为 20ms
+     * @param 持续时间 点击持续时间，如果未定义则默认为 10ms
      * @returns 返回自身，支持链式调用
      * @example 动作构建器.单指点击(100, 100, 50).执行()
      */
-    单指点击(坐标x: 数字, 坐标y: 数字, 持续时间?: 数字): $指针构建器;
+    单指点击(坐标x: 数字, 坐标y: 数字, 持续时间?: 数字): $动作构建器;
 
     /**
      * 快速创建多点点击

package/types/zh//345/233/276/347/211/207/346/250/241/345/235/227.d.ts

@@ -39,7 +39,7 @@ declare namespace $图片 {
    * @example
    * $图片.保存图片(图片ID, "screen.jpg")
    */
-  function 保存图片(图片ID: 字符串, 保存路径: 字符串): 无返回值;
+  function 保存图片(图片ID: 字符串, 保存路径: 字符串): 布尔值;
   /**
    * 图片是否已释放
    * @param imageId 图片id
@@ -268,7 +268,7 @@ declare namespace $图片 {
     区域左上角y: 数字,
     区域右下角x: 数字,
     区域右下角y: 数字
-  ): 字符串;
+  ): 字符串 | null;
   /**
    * 获取图片像素
    * @param 图片ID
@@ -312,7 +312,7 @@ declare namespace $图片 {
    * }
    * $图片.释放图片(图片ID)
    */
-  function 二值化图片(图片ID: 字符串, 阈值: 数字): 字符串;
+  function 二值化图片(图片ID: 字符串, 阈值: 数字): 字符串 | null;
   /**
    * 灰度化
    * @param 图片ID
@@ -327,7 +327,7 @@ declare namespace $图片 {
    * }
    * $图片.释放图片(图片ID)
    */
-  function 灰度化图片(图片ID: 字符串): 字符串;
+  function 灰度化图片(图片ID: 字符串): 字符串 | null;
   /**
    * base64转图片
    * @param base64 base64字符串
@@ -339,7 +339,7 @@ declare namespace $图片 {
    * }
    * $图片.释放图片(图片ID)
    */
-  function base64转图片(base64: 字符串): 字符串;
+  function base64转图片(base64: 字符串): 字符串 | null;
   /**
    * 图片转base64
    * @param 图片ID 图片ID
@@ -354,7 +354,7 @@ declare namespace $图片 {
    * }
    * $图片.释放图片(图片ID)
    */
-  function 图片转base64(图片ID: 字符串, 格式: 字符串, 质量: 数字): 字符串;
+  function 图片转base64(图片ID: 字符串, 格式: 字符串, 质量: 数字): 字符串 | null;
   /**
    * 扫描条码 支持一维码和二维码
    * @param 图片ID 图片ID

package/types/zh//346/202/254/346/265/256/347/252/227/346/250/241/345/235/227.d.ts

@@ -49,6 +49,7 @@ declare namespace $悬浮窗 {
   /**
    * 设置是否允许悬浮窗控制脚本启停
    * @param 是否允许 true代表允许，false代表不允许
+   * @returns true代表成功，false代表失败
    */
-  function 设置是否允许控制脚本启停(是否允许: 布尔值): 无返回值;
+  function 设置是否允许控制脚本启停(是否允许: 布尔值): 布尔值;
 }

package/types/zh//346/226/207/344/273/266/346/250/241/345/235/227.d.ts

@@ -50,10 +50,10 @@ declare namespace $文件 {
   /**
    * 读取文件内容
    * @param 文件路径
-   * @returns 文件内容
+   * @returns 文件内容，如果读取失败返回 null
    * @example $文件.读取文件("config.json")
    */
-  function 读取文件(文件路径: 字符串): 字符串;
+  function 读取文件(文件路径: 字符串): 字符串 | null;
   /**
    * 读取资源文件
    * @param 文件名
@@ -98,17 +98,17 @@ declare namespace $文件 {
    * 读取文件第N行内容
    * @param 文件路径
    * @param 行号
-   * @returns 行内容
+   * @returns 行内容，如果读取失败返回 null
    * @example $文件.读取指定行("config.json", 1)
    */
-  function 读取指定行(文件路径: 字符串, 行号: 数字): 字符串;
+  function 读取指定行(文件路径: 字符串, 行号: 数字): 字符串 | null;
   /**
    * 读取文件所有行内容
    * @param 文件路径
-   * @returns 行内容数组
+   * @returns 行内容数组，如果读取失败返回 null
    * @example $文件.读取所有行("config.json")
    */
-  function 读取所有行(文件路径: 字符串): 数组<字符串>;
+  function 读取所有行(文件路径: 字符串): 数组<字符串> | null;
   /**
    * 文件或者文件夹是否存在
    * @param 文件路径

package/types/zh//347/263/273/347/273/237/346/250/241/345/235/227.d.ts

@@ -21,16 +21,16 @@ declare namespace $系统 {
     env?: 字典<任意类型>
   ): 布尔值;
   /**
-   * 关闭应用
+   * 停止应用
    * @param bundleId 应用bundleId
    * @returns 是否关闭成功
    * @example
-   * const 是否关闭成功 = $系统.关闭应用("cn.magicnode.script")
+   * const 是否关闭成功 = $系统.停止应用("cn.magicnode.script")
    * if (是否关闭成功) {
-   *   $打印信息日志("关闭成功")
-   * }
+     *   $打印信息日志("关闭成功")
+     * }
    */
-  function 关闭应用(bundleId: 字符串): 布尔值;
+  function 停止应用(bundleId: 字符串): 布尔值;
   /**
    * 激活应用 没启动就会启动 启动了就会进入前台
    * @param bundleId 应用bundleId

package/types/zh//350/213/271/346/236/234OCR.d.ts

@@ -33,10 +33,10 @@ declare namespace $苹果OCR {
   /**
    * 执行OCR识别（使用Apple Vision框架）
    * @param 输入源 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
-   * @param 图片边界框左上角x坐标 图片边界框左上角x坐标
-   * @param 图片边界框左上角y坐标 图片边界框左上角y坐标
-   * @param 图片边界框右下角x坐标 图片边界框右下角x坐标
-   * @param 图片边界框右下角y坐标 图片边界框右下角y坐标
+   * @param 图片边界框左上角x坐标 默认 0
+   * @param 图片边界框左上角y坐标 默认 0
+   * @param 图片边界框右下角x坐标 默认 0
+   * @param 图片边界框右下角y坐标 默认 0
    * @param 识别语言数组 识别语言数组，默认为["zh-Hans", "en-US"]
    * @returns 识别结果数组，包含文本、置信度、坐标等信息
    * @example
@@ -57,10 +57,10 @@ declare namespace $苹果OCR {
   /**
    * 执行OCR识别（仅识别数字）0-9.,+-
    * @param 输入源 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
-   * @param 图片边界框左上角x坐标 图片边界框左上角x坐标
-   * @param 图片边界框左上角y坐标 图片边界框左上角y坐标
-   * @param 图片边界框右下角x坐标 图片边界框右下角x坐标
-   * @param 图片边界框右下角y坐标 图片边界框右下角y坐标
+   * @param 图片边界框左上角x坐标 默认 0
+   * @param 图片边界框左上角y坐标 默认 0
+   * @param 图片边界框右下角x坐标 默认 0
+   * @param 图片边界框右下角y坐标 默认 0
    * @returns 识别结果数组，包含文本、置信度、坐标等信息
    * @example
    * const 检查结果数组 = $苹果OCR.识别数字("screen", 0, 0, 100, 100)
@@ -80,10 +80,10 @@ declare namespace $苹果OCR {
    * 执行OCR识别（查找指定文本）
    * @param 输入源 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
    * @param 要查找的文本数组 要查找的文本数组
-   * @param 图片边界框左上角x坐标 图片边界框左上角x坐标
-   * @param 图片边界框左上角y坐标 图片边界框左上角y坐标
-   * @param 图片边界框右下角x坐标 图片边界框右下角x坐标
-   * @param 图片边界框右下角y坐标 图片边界框右下角y坐标
+   * @param 图片边界框左上角x坐标 默认 0
+   * @param 图片边界框左上角y坐标 默认 0
+   * @param 图片边界框右下角x坐标 默认 0
+   * @param 图片边界框右下角y坐标 默认 0
    * @param 识别语言数组 识别语言数组，默认为["zh-Hans", "en-US"]
    * @returns 识别结果数组，包含文本、置信度、坐标等信息
    * @example

package/types/zh//350/256/276/345/244/207/346/250/241/345/235/227.d.ts

@@ -77,7 +77,7 @@ declare namespace $设备 {
    * @returns 屏幕缩放比例
    * @example $设备.获取屏幕缩放比例()
    */
-  function 获取屏幕缩放比例(): number;
+  function 获取屏幕缩放比例(): 数字;
   /**
    * 获取屏幕方向 PORTRAIT 竖屏 LANDSCAPE 横屏
    * @returns 设备方向

package/types/zh//351/205/215/347/275/256/346/250/241/345/235/227.d.ts

@@ -21,10 +21,10 @@ declare namespace $配置 {
   /**
    * 读取配置String
    * @param 配置键 配置key
-   * @returns 配置值
+   * @returns 配置值，如果不存在返回 null
    * @example $配置.读取字符串("key")
    */
-  function 读取字符串(配置键: 字符串): 字符串;
+  function 读取字符串(配置键: 字符串): 字符串 | null;
   /**
    * 读取配置Bool
    * @param 配置键 配置key