ms-types 0.0.53 → 0.0.56

package/package.json

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

package/types/image.d.ts

@@ -8,7 +8,7 @@ declare namespace image {
    * @example
    * const imageId = image.captureFullScreen()
    * if (imageId) {
-   *   image.saveTo(imageId, "screen.png")
+   *   image.saveTo(imageId, "screen.jpg")
    * }
    */
   function captureFullScreen(): string | null;
@@ -17,7 +17,7 @@ declare namespace image {
    * @param imageId 图片id 路径 http地址或者 screen 实时截屏
    * @param filePath 保存路径
    * @example
-   * image.saveTo(imageId, "screen.png")
+   * image.saveTo(imageId, "screen.jpg")
    */
   function saveTo(imageId: string, filePath: string): void;
   /**
@@ -27,7 +27,7 @@ declare namespace image {
    * @example
    * const imageId = image.captureFullScreen()
    * if (imageId) {
-   *   image.saveTo(imageId, "screen.png")
+   *   image.saveTo(imageId, "screen.jpg")
    *   image.isRelease(imageId) // false
    *   image.release(imageId)
    *   image.isRelease(imageId) // true
@@ -63,9 +63,9 @@ declare namespace image {
    * @param path 图片路径
    * @returns 图片id ，如果读取失败则返回null
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
-   *   image.saveTo(imageId, "screen.png")
+   *   image.saveTo(imageId, "screen.jpg")
    * }
    * image.release(imageId)
    */
@@ -75,7 +75,7 @@ declare namespace image {
    * @param fileName 文件名
    * @returns 图片id ，如果读取失败则返回null
    * @example
-   * image.readResImage("test.png")
+   * image.readResImage("test.jpg")
    */
   function readResImage(fileName: string): string | null;
   /**
@@ -84,11 +84,11 @@ declare namespace image {
    * @param degree 旋转角度 只能是 90 -90 180
    * @returns 旋转后的图片id ，如果旋转失败则返回null
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   const newImageId = image.rotateImage(imageId, 90)
    *   if (newImageId) {
-   *     image.saveTo(newImageId, "screen.png")
+   *     image.saveTo(newImageId, "screen.jpg")
    *   }
    *   image.release(imageId)
    * }
@@ -99,13 +99,13 @@ declare namespace image {
    * @param imageId 图片id
    * @param points 颜色点
    * @param threshold 阈值
-   * @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
    * @returns true 相同 false 不同
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   const isSame = image.cmpColor(imageId, "1|2|#6DD1E6-#101010", 10, 0, 0, 100, 100)
    *   if (isSame) {
@@ -127,15 +127,15 @@ declare namespace image {
    * @param imageId 图片id
    * @param color 颜色 支持"主色-偏色"格式，如"0x6DD1E6-0x101010"
    * @param threshold 阈值
-   * @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 limit 限制数量
    * @param orz 查找方向1-8
    * @returns 颜色点数组
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   const points = image.findColor(imageId, "0x6DD1E6-0x101010", 10, 0, 0, 100, 100, 1, 1)
    *   if (points.length > 0) {
@@ -161,15 +161,15 @@ declare namespace image {
    * @param firstColor 第一个颜色
    * @param threshold 阈值
    * @param points 颜色点
-   * @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 limit 限制数量
    * @param orz 查找方向1-8
    * @returns 颜色点数组
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   const points = image.findMultiColor(imageId, "0x6DD1E6-0x101010", 10, "1|2|#6DD1E6-#101010", 0, 0, 100, 100, 1, 1)
    *   if (points.length > 0) {
@@ -194,16 +194,16 @@ declare namespace image {
    * 查找图片
    * @param imageId 图片id
    * @param templateImageId 模板图片id
-   * @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 threshold 阈值
    * @param limit 限制数量
    * @param method 方法
    * @returns 图片数组
    * @example
-   * const points = image.findImage("screen", "template.png", 0, 0, 100, 100, 0.8, 1, 5)
+   * const points = image.findImage("screen", "template.jpg", 0, 0, 100, 100, 0.8, 1, 5)
    * if (points.length > 0) {
    *   logger.info("找到图片")
    * }
@@ -238,7 +238,7 @@ declare namespace image {
    * @param ey 坐标ey
    * @returns 裁剪后的图片id
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   const clipImageId = image.clip(imageId, 0, 0, 100, 100)
    *   if (clipImageId) {
@@ -261,7 +261,7 @@ declare namespace image {
    * @param y 坐标y
    * @returns 颜色值
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   const color = image.pixel(imageId, 0, 0)
    *   logger.info(color)
@@ -275,7 +275,7 @@ declare namespace image {
    * @param color 颜色值
    * @returns 16进制RGB字符串
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   const color = image.pixel(imageId, 0, 0)
    *   logger.info(image.argb(imageId, color))
@@ -289,7 +289,7 @@ declare namespace image {
    * @param threshold 阈值
    * @returns 二值化后的图片id
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   const binaryzationImageId = image.binaryzation(imageId, 128)
    *   if (binaryzationImageId) {
@@ -304,7 +304,7 @@ declare namespace image {
    * @param imageId 图片id
    * @returns 灰度化后的图片id
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   const grayImageId = image.gray(imageId)
    *   if (grayImageId) {
@@ -319,7 +319,7 @@ declare namespace image {
    * @param base64 base64字符串
    * @returns 图片id
    * @example
-   * const imageId = image.base64ToImage("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhAJ/wlseKgAAAABJRU5ErkJggg==")
+   * const imageId = image.base64ToImage("data:image/jpg;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhAJ/wlseKgAAAABJRU5ErkJggg==")
    * if (imageId) {
    *   logger.info("base64转图片成功")
    * }
@@ -333,9 +333,9 @@ declare namespace image {
    * @param q 质量 1-100 数字越大质量越高
    * @returns base64字符串
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
-   *   const base64 = image.toBase64Format(imageId, "png", 100)
+   *   const base64 = image.toBase64Format(imageId, "jpg", 100)
    *   logger.info(base64)
    * }
    * image.release(imageId)
@@ -353,7 +353,7 @@ declare namespace image {
    * @param thickness 线宽
    * @returns 无
    * @example
-   * const imageId = image.readImage("screen.png")
+   * const imageId = image.readImage("screen.jpg")
    * if (imageId) {
    *   image.drawRect(imageId, 0, 0, 100, 100, "#ff0000", 1)
    * }

package/types/index.d.ts

@@ -18,6 +18,7 @@
 /// <reference path="system.d.ts" />
 /// <reference path="thread.d.ts" />
 /// <reference path="tomatoOcr.d.ts" />
+/// <reference path="tts.d.ts" />
 /// <reference path="ui.d.ts" />
 /// <reference path="utils.d.ts" />
-/// <reference path="yolo.d.ts" />
+/// <reference path="yolo.d.ts" />

package/types/node.d.ts

@@ -1,7 +1,7 @@
 /**
  * 节点模块 包含节点操作、节点内容读写等功能
  */
-declare function createNodeSelector(params: {
+declare function createNodeSelector(params?: {
   /**
    *  1 代表不管visible是true还是false都获取，2 代表只获取 visible=true的节点
    */
@@ -116,12 +116,12 @@ declare interface NodeInfo {
   /**
    * 获取父节点
    */
-  parent(): NodeInfo;
+  parent(): NodeInfo | null;
   /**
    * 获取子节点
    * @param index 子节点索引
    */
-  child(index: number): NodeInfo;
+  child(index: number): NodeInfo | null;
   /**
    * 获取所有子节点
    */
@@ -146,20 +146,21 @@ declare interface NodeInfo {
 declare class NodeSelector {
   /**
    * 获取节点信息
-   * @param timeout 超时时间，单位毫秒
+   * @param timeout 超时时间，单位毫秒 默认为 5000 毫秒
    * @returns 节点信息数组
    */
-  getNodeInfo(timeout: number): NodeInfo[];
+  getNodeInfo(timeout?: number): NodeInfo[];
   /**
    * 获取一个节点信息
-   * @param timeout 超时时间，单位毫秒
+   * @param timeout 超时时间，单位毫秒 默认为 5000 毫秒
    * @returns 节点信息
    */
-  getOneNodeInfo(timeout: number): NodeInfo | null;
+  getOneNodeInfo(timeout?: number): NodeInfo | null;
   /**
    * 加载节点
+   * @param timeout 超时时间，单位毫秒 默认为 5000 毫秒
    */
-  loadNode(timeout: number): NodeSelector;
+  loadNode(timeout?: number): NodeSelector;
   /**
    * 清除条件
    */

package/types/paddleOcr.d.ts

@@ -34,10 +34,10 @@ declare namespace paddleOcr {
 
   /**
    * 初始化PP-OCRv5模型
-   * @param maxSideLen 最大边长，默认2000，可不传
+   * @param maxSideLen 最大边长，默认640，可不传
    * @returns 初始化是否成功
    * @example
-   * const loaded = paddleOcr.loadV5(2000)
+   * const loaded = paddleOcr.loadV5(640)
    * if (loaded) {
    *   logger.info("加载成功")
    * }
@@ -46,10 +46,10 @@ declare namespace paddleOcr {
   /**
    * 执行OCR识别
    * @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 confidenceThreshold 置信度阈值，默认0.6
    * @returns 识别结果数组
    * @example

package/types/tts.d.ts

@@ -0,0 +1,100 @@
+/**
+ * TTS（文本转语音）模块 包含语音合成、播放控制等功能
+ */
+declare namespace tts {
+  /**
+   * 语音信息接口
+   */
+  interface VoiceInfo {
+    /** 语音标识符 */
+    identifier: string;
+    /** 语音名称 */
+    name: string;
+    /** 语言代码 */
+    language: string;
+    /** 语音质量等级 */
+    quality: number;
+  }
+
+  /**
+   * 播放文本转语音（5参数版本）
+   * @param text 要转换的文本
+   * @param rate 语速，范围0.0-1.0，默认0.5
+   * @param pitch 音调，范围0.5-2.0，默认1.0
+   * @param volume 音量，范围0.0-1.0，默认1.0
+   * @param language 语言代码，默认"zh-CN"
+   * @returns 是否成功开始播放
+   * @example
+   * const success = tts.speak("你好世界", 0.5, 1.0, 1.0, "zh-CN");
+   */
+  function speak(
+    text: string,
+    rate: number,
+    pitch: number,
+    volume: number,
+    language: string
+  ): boolean;
+
+  /**
+   * 播放文本转语音（简化版本）
+   * @param text 要转换的文本
+   * @returns 是否成功开始播放
+   * @example
+   * const success = tts.speak("Hello World");
+   */
+  function speak(text: string): boolean;
+
+  /**
+   * 停止当前播放
+   * @example
+   * tts.stop();
+   */
+  function stop(): void;
+
+  /**
+   * 暂停播放
+   * @example
+   * tts.pause();
+   */
+  function pause(): void;
+
+  /**
+   * 继续播放
+   * @example
+   * tts.resume();
+   */
+  function resume(): void;
+
+  /**
+   * 检查是否正在播放
+   * @returns 是否正在播放
+   * @example
+   * if (tts.isSpeaking()) {
+   *   logger.info("正在播放");
+   * }
+   */
+  function isSpeaking(): boolean;
+
+  /**
+   * 获取可用的语音列表
+   * @returns 语音信息数组
+   * @example
+   * const voices = tts.getAvailableVoices();
+   * voices.forEach(voice => {
+   *   logger.info(`语音: ${voice.name}, 语言: ${voice.language}, 标识符: ${voice.identifier}`);
+   * });
+   */
+  function getAvailableVoices(): VoiceInfo[];
+
+  /**
+   * 设置语音
+   * @param voiceIdentifier 语音标识符
+   * @returns 是否设置成功
+   * @example
+   * const success = tts.setVoice("com.apple.ttsbundle.Samantha-compact");
+   * if (success) {
+   *   logger.info("语音设置成功");
+   * }
+   */
+  function setVoice(voiceIdentifier: string): boolean;
+}

package/types/ui.d.ts

@@ -62,13 +62,6 @@ declare namespace ms {
    */
   function getAllConfig(): Promise<Record<string, any>>;
 
-  /**
-   * 设置所有配置
-   * @param configs 包含所有配置的字典
-   * @returns 如果设置成功返回true，否则返回false
-   */
-  function setAllConfig(configs: Record<string, any>): Promise<boolean>;
-
   /**
    * 获取服务器设备ID
    * @returns 服务器设备ID