ms-types 0.0.55 → 0.0.56

package/types/mysql.d.ts

@@ -1,174 +1,174 @@
-/**
- * MySQL 数据库模块 - 提供 MySQL 数据库连接和操作功能
- */
-declare namespace mysql {
-  /**
-   * MySQL 连接配置接口
-   */
-  interface MySQLConfig {
-    /** 数据库主机地址 */
-    host: string;
-    /** 数据库端口，默认 3306 */
-    port?: number;
-    /** 用户名 */
-    username: string;
-    /** 密码 */
-    password: string;
-    /** 数据库名 */
-    database: string;
-    /** 字符集，默认 utf8mb4 */
-    charset?: string;
-  }
-
-  /**
-   * MySQL 查询结果接口
-   */
-  interface MySQLResult {
-    /** 查询结果数据行 */
-    rows: Record<string, any>[];
-    /** 受影响的行数 */
-    affectedRows: number;
-    /** 插入ID（仅适用于INSERT操作） */
-    insertId?: number;
-    /** 查询是否成功 */
-    success: boolean;
-    /** 错误信息 */
-    error?: string;
-  }
-
-  /**
-   * 连接到数据库
-   * @param config 连接配置对象
-   * @returns 是否连接成功
-   * @example
-   * const connected = mysql.connect({
-   *   host: "localhost",
-   *   port: 3306,
-   *   username: "root",
-   *   password: "password",
-   *   database: "test_db",
-   *   charset: "utf8mb4"
-   * })
-   *
-   * if (connected) {
-   *   logger.info("数据库连接成功")
-   * }
-   */
-  function connect(config: MySQLConfig): boolean;
-
-  /**
-   * 断开数据库连接
-   * @example
-   * mysql.disconnect()
-   */
-  function disconnect(): void;
-
-  /**
-   * 检查连接状态
-   * @returns 是否已连接
-   * @example
-   * if (mysql.isConnected()) {
-   *   logger.info("数据库已连接")
-   * }
-   */
-  function isConnected(): boolean;
-
-  /**
-   * 执行查询操作（SELECT）
-   * @param sql SQL 查询语句
-   * @param params 查询参数数组，可选
-   * @returns 查询结果对象
-   * @example
-   * // 简单查询
-   * const result = mysql.query("SELECT * FROM users")
-   *
-   * // 带参数查询
-   * const result = mysql.query("SELECT * FROM users WHERE id = ?", [1])
-   *
-   * // 处理结果
-   * if (result.success) {
-   *   logger.info("查询到 " + result.rows.length + " 条记录")
-   *   result.rows.forEach(row => {
-   *     logger.info(row)
-   *   })
-   * } else {
-   *   console.error("查询失败: " + result.error)
-   * }
-   */
-  function query(sql: string, params?: any[]): MySQLResult;
-
-  /**
-   * 执行更新操作（INSERT、UPDATE、DELETE）
-   * @param sql SQL 语句
-   * @param params 参数数组，可选
-   * @returns 执行结果对象
-   * @example
-   * // 插入数据
-   * const result = mysql.execute(
-   *   "INSERT INTO users (name, email) VALUES (?, ?)",
-   *   ["张三", "zhangsan@example.com"]
-   * )
-   *
-   * // 更新数据
-   * const result = mysql.execute(
-   *   "UPDATE users SET name = ? WHERE id = ?",
-   *   ["李四", 1]
-   * )
-   *
-   * // 删除数据
-   * const result = mysql.execute("DELETE FROM users WHERE id = ?", [1])
-   *
-   * // 处理结果
-   * if (result.success) {
-   *   logger.info("影响了 " + result.affectedRows + " 行")
-   *   if (result.insertId) {
-   *     logger.info("新插入记录的ID: " + result.insertId)
-   *   }
-   * } else {
-   *   console.error("执行失败: " + result.error)
-   * }
-   */
-  function execute(sql: string, params?: any[]): MySQLResult;
-
-  /**
-   * 开始事务
-   * @returns 是否成功开始事务
-   * @example
-   * if (mysql.beginTransaction()) {
-   *   try {
-   *     mysql.execute("INSERT INTO users (name) VALUES (?)", ["用户1"])
-   *     mysql.execute("INSERT INTO users (name) VALUES (?)", ["用户2"])
-   *     mysql.commit()
-   *     logger.info("事务提交成功")
-   *   } catch (error) {
-   *     mysql.rollback()
-   *     console.error("事务回滚")
-   *   }
-   * }
-   */
-  function beginTransaction(): boolean;
-
-  /**
-   * 提交事务
-   * @returns 是否成功提交
-   * @example
-   * mysql.beginTransaction()
-   * mysql.execute("INSERT INTO users (name) VALUES (?)", ["测试用户"])
-   * if (mysql.commit()) {
-   *   logger.info("事务提交成功")
-   * }
-   */
-  function commit(): boolean;
-
-  /**
-   * 回滚事务
-   * @returns 是否成功回滚
-   * @example
-   * mysql.beginTransaction()
-   * mysql.execute("INSERT INTO users (name) VALUES (?)", ["测试用户"])
-   * if (mysql.rollback()) {
-   *   logger.info("事务回滚成功")
-   * }
-   */
-  function rollback(): boolean;
-}
+/**
+ * MySQL 数据库模块 - 提供 MySQL 数据库连接和操作功能
+ */
+declare namespace mysql {
+  /**
+   * MySQL 连接配置接口
+   */
+  interface MySQLConfig {
+    /** 数据库主机地址 */
+    host: string;
+    /** 数据库端口，默认 3306 */
+    port?: number;
+    /** 用户名 */
+    username: string;
+    /** 密码 */
+    password: string;
+    /** 数据库名 */
+    database: string;
+    /** 字符集，默认 utf8mb4 */
+    charset?: string;
+  }
+
+  /**
+   * MySQL 查询结果接口
+   */
+  interface MySQLResult {
+    /** 查询结果数据行 */
+    rows: Record<string, any>[];
+    /** 受影响的行数 */
+    affectedRows: number;
+    /** 插入ID（仅适用于INSERT操作） */
+    insertId?: number;
+    /** 查询是否成功 */
+    success: boolean;
+    /** 错误信息 */
+    error?: string;
+  }
+
+  /**
+   * 连接到数据库
+   * @param config 连接配置对象
+   * @returns 是否连接成功
+   * @example
+   * const connected = mysql.connect({
+   *   host: "localhost",
+   *   port: 3306,
+   *   username: "root",
+   *   password: "password",
+   *   database: "test_db",
+   *   charset: "utf8mb4"
+   * })
+   *
+   * if (connected) {
+   *   logger.info("数据库连接成功")
+   * }
+   */
+  function connect(config: MySQLConfig): boolean;
+
+  /**
+   * 断开数据库连接
+   * @example
+   * mysql.disconnect()
+   */
+  function disconnect(): void;
+
+  /**
+   * 检查连接状态
+   * @returns 是否已连接
+   * @example
+   * if (mysql.isConnected()) {
+   *   logger.info("数据库已连接")
+   * }
+   */
+  function isConnected(): boolean;
+
+  /**
+   * 执行查询操作（SELECT）
+   * @param sql SQL 查询语句
+   * @param params 查询参数数组，可选
+   * @returns 查询结果对象
+   * @example
+   * // 简单查询
+   * const result = mysql.query("SELECT * FROM users")
+   *
+   * // 带参数查询
+   * const result = mysql.query("SELECT * FROM users WHERE id = ?", [1])
+   *
+   * // 处理结果
+   * if (result.success) {
+   *   logger.info("查询到 " + result.rows.length + " 条记录")
+   *   result.rows.forEach(row => {
+   *     logger.info(row)
+   *   })
+   * } else {
+   *   console.error("查询失败: " + result.error)
+   * }
+   */
+  function query(sql: string, params?: any[]): MySQLResult;
+
+  /**
+   * 执行更新操作（INSERT、UPDATE、DELETE）
+   * @param sql SQL 语句
+   * @param params 参数数组，可选
+   * @returns 执行结果对象
+   * @example
+   * // 插入数据
+   * const result = mysql.execute(
+   *   "INSERT INTO users (name, email) VALUES (?, ?)",
+   *   ["张三", "zhangsan@example.com"]
+   * )
+   *
+   * // 更新数据
+   * const result = mysql.execute(
+   *   "UPDATE users SET name = ? WHERE id = ?",
+   *   ["李四", 1]
+   * )
+   *
+   * // 删除数据
+   * const result = mysql.execute("DELETE FROM users WHERE id = ?", [1])
+   *
+   * // 处理结果
+   * if (result.success) {
+   *   logger.info("影响了 " + result.affectedRows + " 行")
+   *   if (result.insertId) {
+   *     logger.info("新插入记录的ID: " + result.insertId)
+   *   }
+   * } else {
+   *   console.error("执行失败: " + result.error)
+   * }
+   */
+  function execute(sql: string, params?: any[]): MySQLResult;
+
+  /**
+   * 开始事务
+   * @returns 是否成功开始事务
+   * @example
+   * if (mysql.beginTransaction()) {
+   *   try {
+   *     mysql.execute("INSERT INTO users (name) VALUES (?)", ["用户1"])
+   *     mysql.execute("INSERT INTO users (name) VALUES (?)", ["用户2"])
+   *     mysql.commit()
+   *     logger.info("事务提交成功")
+   *   } catch (error) {
+   *     mysql.rollback()
+   *     console.error("事务回滚")
+   *   }
+   * }
+   */
+  function beginTransaction(): boolean;
+
+  /**
+   * 提交事务
+   * @returns 是否成功提交
+   * @example
+   * mysql.beginTransaction()
+   * mysql.execute("INSERT INTO users (name) VALUES (?)", ["测试用户"])
+   * if (mysql.commit()) {
+   *   logger.info("事务提交成功")
+   * }
+   */
+  function commit(): boolean;
+
+  /**
+   * 回滚事务
+   * @returns 是否成功回滚
+   * @example
+   * mysql.beginTransaction()
+   * mysql.execute("INSERT INTO users (name) VALUES (?)", ["测试用户"])
+   * if (mysql.rollback()) {
+   *   logger.info("事务回滚成功")
+   * }
+   */
+  function rollback(): boolean;
+}

package/types/netCard.d.ts

@@ -1,30 +1,30 @@
-declare namespace netCard {
-  /**
-   * 验证卡密
-   * @param cardNo 卡密
-   * @returns 是否验证成功
-   */
-  function verify(cardNo: string): boolean;
-
-  /**
-   * 设置卡密备注
-   * @param remark 备注
-   * @returns 是否设置成功
-   */
-  function setCardRemark(remark: string): boolean;
-
-  /**
-   * 设置值
-   * @param key 键
-   * @param value 值
-   * @returns 成功返回设置的value，失败返回空字符串
-   */
-  function setValue(key: string, value: string): string;
-
-  /**
-   * 获取值
-   * @param key 键
-   * @returns 成功返回值，失败返回空字符串
-   */
-  function getValue(key: string): string;
-}
+declare namespace netCard {
+  /**
+   * 验证卡密
+   * @param cardNo 卡密
+   * @returns 是否验证成功
+   */
+  function verify(cardNo: string): boolean;
+
+  /**
+   * 设置卡密备注
+   * @param remark 备注
+   * @returns 是否设置成功
+   */
+  function setCardRemark(remark: string): boolean;
+
+  /**
+   * 设置值
+   * @param key 键
+   * @param value 值
+   * @returns 成功返回设置的value，失败返回空字符串
+   */
+  function setValue(key: string, value: string): string;
+
+  /**
+   * 获取值
+   * @param key 键
+   * @returns 成功返回值，失败返回空字符串
+   */
+  function getValue(key: string): string;
+}

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 → 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/pip.d.ts

@@ -1,50 +1,50 @@
-declare namespace pip {
-  interface LogViewParams {
-    /**
-     * 悬浮窗宽度，不能小于 100
-     */
-    width: number;
-    /**
-     * 悬浮窗高度，不能小于 100
-     */
-    height: number;
-    /**
-     * 日志的字体大小
-     */
-    textSize: number;
-    /**
-     * 日志的文字颜色，格式如 #FFFFFF
-     */
-    textColor: string;
-    /**
-     * 日志的背景颜色，格式如 #000000
-     */
-    backgroundColor: string;
-  }
-  /**
-   * 设置悬浮窗日志窗口的显示参数[显示日志窗口之前调用才会生效]
-   * @param params 包含显示参数的字典
-   */
-  function setLogViewParams(params: LogViewParams): void;
-  /**
-   * 判断悬浮窗是否打开
-   * @returns true代表开启了悬浮窗，false代表没有开启
-   */
-  function isPipActive(): boolean;
-  /**
-   * 显示日志窗口[App 必须在前台才可调用]
-   * 必须iOS设备支持悬浮窗功能，并且开启悬浮窗
-   * @returns true代表成功，false代表失败
-   */
-  function showLogWindow(): boolean;
-  /**
-   * 关闭日志窗口[App 必须在前台才可调用]
-   * @returns true代表成功，false代表失败
-   */
-  function closeLogWindow(): boolean;
-  /**
-   * 设置是否允许悬浮窗控制脚本启停
-   * @param ctrl true代表允许，false代表不允许
-   */
-  function setPipCtrlScript(ctrl: boolean): void;
-}
+declare namespace pip {
+  interface LogViewParams {
+    /**
+     * 悬浮窗宽度，不能小于 100
+     */
+    width: number;
+    /**
+     * 悬浮窗高度，不能小于 100
+     */
+    height: number;
+    /**
+     * 日志的字体大小
+     */
+    textSize: number;
+    /**
+     * 日志的文字颜色，格式如 #FFFFFF
+     */
+    textColor: string;
+    /**
+     * 日志的背景颜色，格式如 #000000
+     */
+    backgroundColor: string;
+  }
+  /**
+   * 设置悬浮窗日志窗口的显示参数[显示日志窗口之前调用才会生效]
+   * @param params 包含显示参数的字典
+   */
+  function setLogViewParams(params: LogViewParams): void;
+  /**
+   * 判断悬浮窗是否打开
+   * @returns true代表开启了悬浮窗，false代表没有开启
+   */
+  function isPipActive(): boolean;
+  /**
+   * 显示日志窗口[App 必须在前台才可调用]
+   * 必须iOS设备支持悬浮窗功能，并且开启悬浮窗
+   * @returns true代表成功，false代表失败
+   */
+  function showLogWindow(): boolean;
+  /**
+   * 关闭日志窗口[App 必须在前台才可调用]
+   * @returns true代表成功，false代表失败
+   */
+  function closeLogWindow(): boolean;
+  /**
+   * 设置是否允许悬浮窗控制脚本启停
+   * @param ctrl true代表允许，false代表不允许
+   */
+  function setPipCtrlScript(ctrl: boolean): void;
+}

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;
+}