ms-types 0.9.3 → 0.9.5

package/package.json

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

package/types/appleocr.d.ts

@@ -121,17 +121,18 @@ declare namespace appleOcr {
   ): OCRResult[];
 
   /**
-   * 执行OCR识别（查找指定文本）
+   * 执行OCR识别，在整段识别文本中查找指定子串
    * @param input 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
-   * @param texts 要查找的文本数组
+   * @param texts 要查找的目标文本数组，可匹配识别结果中的子串
    * @param x 边界框左上角x坐标
    * @param y 边界框左上角y坐标
    * @param ex 边界框右下角x坐标
    * @param ey 边界框右下角y坐标
    * @param languages 识别语言数组，默认为["zh-Hans", "en-US"]
-   * @returns 识别结果数组，包含文本、置信度、坐标等信息
+   * @param exactMatch 是否完整匹配，默认 false 表示包含匹配；传 true 时要求整条 OCR 识别结果文本等于目标文本
+   * @returns 命中子串的识别结果数组，坐标对应目标子串区域
    * @example
-   * const results = appleOcr.findText("screen", ["123", "456"], 0, 0, 100, 100, ["zh-Hans", "en-US"])
+   * const results = appleOcr.findText("screen", ["开始"], 0, 0, 100, 100, ["zh-Hans", "en-US"])
    * results.forEach(result => {
    *   logi(`文本: ${result.text}, 置信度: ${result.confidence}`)
    * })
@@ -143,21 +144,23 @@ declare namespace appleOcr {
     y?: number,
     ex?: number,
     ey?: number,
-    languages?: string[]
+    languages?: string[],
+    exactMatch?: boolean
   ): OCRResult[];
 
   /**
-   * 查找指定文本，并将结果坐标映射为原图/全屏绝对坐标。
+   * 查找指定子串，并将子串结果坐标映射为原图/全屏绝对坐标。
    * @param input 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
-   * @param texts 要查找的文本数组
+   * @param texts 要查找的目标文本数组，可匹配识别结果中的子串
    * @param x 边界框左上角x坐标
    * @param y 边界框左上角y坐标
    * @param ex 边界框右下角x坐标
    * @param ey 边界框右下角y坐标
    * @param languages 识别语言数组，默认为["zh-Hans", "en-US"]
-   * @returns 识别结果数组，坐标为原图/全屏绝对坐标
+   * @param exactMatch 是否完整匹配，默认 false 表示包含匹配；传 true 时要求整条 OCR 识别结果文本等于目标文本
+   * @returns 命中子串的识别结果数组，坐标为原图/全屏绝对坐标
    * @example
-   * const results = appleOcr.findTextAbs("screen", ["确定"], 100, 100, 500, 400)
+   * const results = appleOcr.findTextAbs("screen", ["开始"], 100, 100, 500, 400)
    * if (results.length > 0) {
    *   action.click(results[0].centerX, results[0].centerY)
    * }
@@ -169,6 +172,7 @@ declare namespace appleOcr {
     y?: number,
     ex?: number,
     ey?: number,
-    languages?: string[]
+    languages?: string[],
+    exactMatch?: boolean
   ): OCRResult[];
 }

package/types/global.d.ts

@@ -6,6 +6,10 @@ declare const __runMode__: "agent" | "hid";
  * 是否是调试模式
  */
 declare const __debug__: boolean;
+/**
+ * 当前脚本是否在运行
+ */
+declare const __isRunning__: boolean;
 /**
  * 平台标识
  */

package/types/paddleocr.d.ts

@@ -99,6 +99,7 @@ declare namespace paddleOcr {
    * @param ex 裁剪区域右下角 x 坐标，全屏传 0，默认 0
    * @param ey 裁剪区域右下角 y 坐标，全屏传 0，默认 0
    * @param confidenceThreshold 置信度阈值，默认 0.6
+   * @param exactMatch 是否完整匹配，默认 false 表示包含匹配；传 true 时要求整条 OCR 识别结果文本等于目标文本
    * @returns 匹配到的子串结果数组，坐标相对于裁剪区域
    * @example
    * const results = paddleOcr.findText("screen", ["确定"], 100, 100, 500, 300, 0.6)
@@ -114,6 +115,7 @@ declare namespace paddleOcr {
     ex?: number,
     ey?: number,
     confidenceThreshold?: number,
+    exactMatch?: boolean,
   ): OCRResult[];
   /**
    * 查找目标文本并返回对应子串的原图/全屏绝对坐标
@@ -124,6 +126,7 @@ declare namespace paddleOcr {
    * @param ex 裁剪区域右下角 x 坐标，全屏传 0，默认 0
    * @param ey 裁剪区域右下角 y 坐标，全屏传 0，默认 0
    * @param confidenceThreshold 置信度阈值，默认 0.6
+   * @param exactMatch 是否完整匹配，默认 false 表示包含匹配；传 true 时要求整条 OCR 识别结果文本等于目标文本
    * @returns 匹配到的子串结果数组，坐标为原图/全屏绝对坐标
    * @example
    * const results = paddleOcr.findTextAbs("screen", ["确定"], 100, 100, 500, 300, 0.6)
@@ -139,6 +142,7 @@ declare namespace paddleOcr {
     ex?: number,
     ey?: number,
     confidenceThreshold?: number,
+    exactMatch?: boolean,
   ): OCRResult[];
   /**
    * 释放OCR模型资源

package/types/pip.d.ts

@@ -16,8 +16,45 @@ declare namespace pip {
    */
   function switchToKeepAliveMode(): boolean;
   /**
-   * 切换到关闭模式
+   * 切换到自定义模式[首次显示悬浮窗时 App 必须在前台]
    * @returns true代表已提交切换请求
    */
-  function switchToOffMode(): boolean;
+  function switchToCustomMode(): boolean;
+  /**
+   * 关闭悬浮窗
+   * @returns true代表已提交关闭请求
+   */
+  function closeWindow(): boolean;
+  /**
+   * 设置日志模式或自定义模式的悬浮窗内容尺寸
+   * 日志模式和自定义模式会分别持久化尺寸；悬浮窗关闭或保活模式返回 false
+   * @param width 目标内容宽度
+   * @param height 目标内容高度
+   * @returns true代表尺寸已提交，false代表当前模式不允许设置或宽高无效
+   */
+  function setContentSize(width: number, height: number): boolean;
+  /**
+   * 设置自定义模式显示的纯文本
+   * @param text 要显示的文本，支持换行
+   * @returns true代表文本已提交
+   */
+  function setCustomText(text: string): boolean;
+  /**
+   * 设置自定义模式显示文本的文字颜色
+   * @param color 文字颜色，支持 RRGGBB、RRGGBBAA，可带 # 前缀；末尾 AA 为透明度
+   * @returns true代表文字颜色已提交
+   */
+  function setCustomTextColor(color: string): boolean;
+  /**
+   * 设置自定义模式显示文本的文字大小
+   * @param fontSize 文字字号，必须是有效数字
+   * @returns true代表文字大小已提交，false代表字号无效
+   */
+  function setCustomTextSize(fontSize: number): boolean;
+  /**
+   * 设置自定义模式显示区域的背景色
+   * @param color 背景颜色，支持 RRGGBB、RRGGBBAA，可带 # 前缀；末尾 AA 为透明度
+   * @returns true代表背景色已提交
+   */
+  function setCustomBackgroundColor(color: string): boolean;
 }

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

@@ -100,6 +100,7 @@ declare namespace $PaddleOCR {
    * @param 图片边界框右下角x坐标 裁剪区域右下角 x，全屏传 0，默认 0
    * @param 图片边界框右下角y坐标 裁剪区域右下角 y，全屏传 0，默认 0
    * @param 置信度阈值 置信度阈值，默认 0.6
+   * @param 是否完整匹配 默认 false 表示包含匹配；传 true 时要求整条 OCR 识别结果文本等于目标文本
    * @returns 匹配到的子串结果数组，坐标相对于裁剪区域
    * @example
    * const 结果 = $PaddleOCR.查找文本("screen", ["确定"], 100, 100, 500, 300, 0.6)
@@ -115,6 +116,7 @@ declare namespace $PaddleOCR {
     图片边界框右下角x坐标?: 数字,
     图片边界框右下角y坐标?: 数字,
     置信度阈值?: 数字,
+    是否完整匹配?: 布尔值,
   ): 数组<OCR识别结果>;
   /**
    * 查找目标文本并返回对应子串的原图/全屏绝对坐标
@@ -125,6 +127,7 @@ declare namespace $PaddleOCR {
    * @param 图片边界框右下角x坐标 裁剪区域右下角 x，全屏传 0，默认 0
    * @param 图片边界框右下角y坐标 裁剪区域右下角 y，全屏传 0，默认 0
    * @param 置信度阈值 置信度阈值，默认 0.6
+   * @param 是否完整匹配 默认 false 表示包含匹配；传 true 时要求整条 OCR 识别结果文本等于目标文本
    * @returns 匹配到的子串结果数组，坐标为原图/全屏绝对坐标
    * @example
    * const 结果 = $PaddleOCR.查找文本绝对坐标("screen", ["确定"], 100, 100, 500, 300, 0.6)
@@ -140,6 +143,7 @@ declare namespace $PaddleOCR {
     图片边界框右下角x坐标?: 数字,
     图片边界框右下角y坐标?: 数字,
     置信度阈值?: 数字,
+    是否完整匹配?: 布尔值,
   ): 数组<OCR识别结果>;
   /**
    * 释放OCR模型资源

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

@@ -15,6 +15,10 @@ declare const $运行模式: "agent" | "hid";
  * 是否是调试模式
  */
 declare const $是否调试: 布尔值;
+/**
+ * 当前脚本是否在运行
+ */
+declare const $是否运行: 布尔值;
 /**
  * 平台标识
  */

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

@@ -20,8 +20,45 @@ declare namespace $悬浮窗 {
    */
   function 切换到保活模式(): 布尔值;
   /**
-   * 切换到关闭模式
+   * 切换到自定义模式[首次显示悬浮窗时 App 必须在前台]
    * @returns true代表已提交切换请求
    */
-  function 切换到关闭模式(): 布尔值;
+  function 切换到自定义模式(): 布尔值;
+  /**
+   * 关闭悬浮窗
+   * @returns true代表已提交关闭请求
+   */
+  function 关闭悬浮窗(): 布尔值;
+  /**
+   * 设置日志模式或自定义模式的悬浮窗内容尺寸
+   * 日志模式和自定义模式会分别持久化尺寸；悬浮窗关闭或保活模式返回 false
+   * @param 宽度 目标内容宽度
+   * @param 高度 目标内容高度
+   * @returns true代表尺寸已提交，false代表当前模式不允许设置或宽高无效
+   */
+  function 设置内容尺寸(宽度: 数字, 高度: 数字): 布尔值;
+  /**
+   * 设置自定义模式显示的纯文本
+   * @param 文本 要显示的文本，支持换行
+   * @returns true代表文本已提交
+   */
+  function 设置自定义文本(文本: 字符串): 布尔值;
+  /**
+   * 设置自定义模式显示文本的文字颜色
+   * @param 颜色 文字颜色，支持 RRGGBB、RRGGBBAA，可带 # 前缀；末尾 AA 为透明度
+   * @returns true代表文字颜色已提交
+   */
+  function 设置自定义文字颜色(颜色: 字符串): 布尔值;
+  /**
+   * 设置自定义模式显示文本的文字大小
+   * @param 字号 文字字号，必须是有效数字
+   * @returns true代表文字大小已提交，false代表字号无效
+   */
+  function 设置自定义文字大小(字号: 数字): 布尔值;
+  /**
+   * 设置自定义模式显示区域的背景色
+   * @param 颜色 背景颜色，支持 RRGGBB、RRGGBBAA，可带 # 前缀；末尾 AA 为透明度
+   * @returns true代表背景色已提交
+   */
+  function 设置自定义背景色(颜色: 字符串): 布尔值;
 }

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

@@ -123,17 +123,18 @@ declare namespace $苹果OCR {
   ): 数组<OCR识别结果>;
 
   /**
-   * 执行OCR识别（查找指定文本）
+   * 执行OCR识别，在整段识别文本中查找指定子串
    * @param 输入源 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
-   * @param 要查找的文本数组 要查找的文本数组
+   * @param 要查找的文本数组 要查找的目标文本数组，可匹配识别结果中的子串
    * @param 图片边界框左上角x坐标 默认 0
    * @param 图片边界框左上角y坐标 默认 0
    * @param 图片边界框右下角x坐标 默认 0
    * @param 图片边界框右下角y坐标 默认 0
    * @param 识别语言数组 识别语言数组，默认为["zh-Hans", "en-US"]
-   * @returns 识别结果数组，包含文本、置信度、坐标等信息
+   * @param 是否完整匹配 默认 false 表示包含匹配；传 true 时要求整条 OCR 识别结果文本等于目标文本
+   * @returns 命中子串的识别结果数组，坐标对应目标子串区域
    * @example
-   * const 检查结果数组 = $苹果OCR.查找文本("screen", ["123", "456"], 0, 0, 100, 100, ["zh-Hans", "en-US"])
+   * const 检查结果数组 = $苹果OCR.查找文本("screen", ["开始"], 0, 0, 100, 100, ["zh-Hans", "en-US"])
    * 检查结果数组.forEach(目标 => {
    *   $打印信息日志(`文本: ${目标.text}, 置信度: ${目标.confidence}`)
    * })
@@ -145,21 +146,23 @@ declare namespace $苹果OCR {
     图片边界框左上角y坐标?: 数字,
     图片边界框右下角x坐标?: 数字,
     图片边界框右下角y坐标?: 数字,
-    识别语言数组?: 数组<字符串>
+    识别语言数组?: 数组<字符串>,
+    是否完整匹配?: 布尔值
   ): 数组<OCR识别结果>;
 
   /**
-   * 查找指定文本，并将结果坐标映射为原图/全屏绝对坐标。
+   * 查找指定子串，并将子串结果坐标映射为原图/全屏绝对坐标。
    * @param 输入源 输入源（imageId、URL字符串、文件路径或"screen"，"screen"表示使用当前屏幕）
-   * @param 要查找的文本数组 要查找的文本数组
+   * @param 要查找的文本数组 要查找的目标文本数组，可匹配识别结果中的子串
    * @param 图片边界框左上角x坐标 默认 0
    * @param 图片边界框左上角y坐标 默认 0
    * @param 图片边界框右下角x坐标 默认 0
    * @param 图片边界框右下角y坐标 默认 0
    * @param 识别语言数组 识别语言数组，默认为["zh-Hans", "en-US"]
-   * @returns 识别结果数组，坐标为原图/全屏绝对坐标
+   * @param 是否完整匹配 默认 false 表示包含匹配；传 true 时要求整条 OCR 识别结果文本等于目标文本
+   * @returns 命中子串的识别结果数组，坐标为原图/全屏绝对坐标
    * @example
-   * const 检查结果数组 = $苹果OCR.查找文本绝对坐标("screen", ["确定"], 100, 100, 500, 400)
+   * const 检查结果数组 = $苹果OCR.查找文本绝对坐标("screen", ["开始"], 100, 100, 500, 400)
    * if (检查结果数组.length > 0) {
    *   $点击(检查结果数组[0].centerX, 检查结果数组[0].centerY)
    * }
@@ -171,6 +174,7 @@ declare namespace $苹果OCR {
     图片边界框左上角y坐标?: 数字,
     图片边界框右下角x坐标?: 数字,
     图片边界框右下角y坐标?: 数字,
-    识别语言数组?: 数组<字符串>
+    识别语言数组?: 数组<字符串>,
+    是否完整匹配?: 布尔值
   ): 数组<OCR识别结果>;
 }