ms-types 0.9.36 → 0.9.38

package/package.json

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

package/types/lua/cv.lua

@@ -824,7 +824,7 @@ function _OpenCV.set(mat, options) return false end
 ---@return OpenCV.Mat|nil
 function _OpenCV.copyTo(mat, mask) return nil end
 
---- cvtColor
+--- cvtColor；源图通道必须和转换码一致，例如 COLOR_BGR2GRAY 要 3 通道。
 ---@param mat OpenCV.Mat
 ---@param code number
 ---@return OpenCV.Mat|nil
@@ -836,7 +836,7 @@ function _OpenCV.cvtColor(mat, code) return nil end
 ---@return OpenCV.Mat|nil
 function _OpenCV.threshold(mat, options) return nil end
 
---- adaptiveThreshold
+--- adaptiveThreshold，只接受 CV_8UC1。
 ---@param mat OpenCV.Mat
 ---@param options OpenCV.AdaptiveThresholdOptions
 ---@return OpenCV.Mat|nil
@@ -890,12 +890,12 @@ function _OpenCV.addWeighted(src1, options) return nil end
 ---@return OpenCV.Mat|nil
 function _OpenCV.convertScaleAbs(mat, options) return nil end
 
---- countNonZero
+--- countNonZero，只接受单通道 Mat；多通道返回 -1。
 ---@param mat OpenCV.Mat
 ---@return number
 function _OpenCV.countNonZero(mat) return 0 end
 
---- minMaxLoc
+--- minMaxLoc，只接受单通道 Mat；多通道返回 nil。可选 mask 必须是 CV_8UC1。
 ---@param mat OpenCV.Mat
 ---@param options OpenCV.MaskOptions|nil
 ---@return OpenCV.MinMaxLocResult|nil
@@ -935,13 +935,13 @@ function _OpenCV.blur(mat, options) return nil end
 ---@return OpenCV.Mat|nil
 function _OpenCV.medianBlur(mat, options) return nil end
 
---- bilateralFilter
+--- bilateralFilter，只接受 1 或 3 通道，深度 CV_8U 或 CV_32F。
 ---@param mat OpenCV.Mat
 ---@param options OpenCV.BilateralFilterOptions
 ---@return OpenCV.Mat|nil
 function _OpenCV.bilateralFilter(mat, options) return nil end
 
---- Canny
+--- Canny，只接受 8 位图（CV_8U，1/3/4 通道均可）。
 ---@param mat OpenCV.Mat
 ---@param options OpenCV.CannyOptions
 ---@return OpenCV.Mat|nil
@@ -959,7 +959,7 @@ function _OpenCV.Sobel(mat, options) return nil end
 ---@return OpenCV.Mat|nil
 function _OpenCV.Laplacian(mat, options) return nil end
 
---- equalizeHist
+--- equalizeHist，只接受 CV_8UC1。
 ---@param mat OpenCV.Mat
 ---@return OpenCV.Mat|nil
 function _OpenCV.equalizeHist(mat) return nil end
@@ -1130,7 +1130,7 @@ function _OpenCV.SIFT(mat, options) return nil end
 ---@return OpenCV.FeatureResult|nil
 function _OpenCV.ORB(mat, options) return nil end
 
---- FAST
+--- FAST，只接受 CV_8UC1。
 ---@param mat OpenCV.Mat
 ---@param options OpenCV.FASTOptions|nil
 ---@return OpenCV.FASTResult|nil
@@ -1237,7 +1237,7 @@ function _OpenCV.floodFill(mat, options) return nil end
 ---@return OpenCV.Point[]|nil
 function _OpenCV.convexHull(points, options) return nil end
 
---- moments
+--- moments；Mat 输入必须是单通道栅格或 2 通道点集。
 ---@param matOrPoints OpenCV.Mat|OpenCV.Point[]
 ---@param options OpenCV.MomentsOptions|nil
 ---@return OpenCV.MomentsResult|nil

package/types/lua/file.lua

@@ -19,7 +19,7 @@ function _File.mkdirs(path) return true end
 
 --- 读取文件
 --- @param path string 路径
---- @return string 内容
+--- @return string 内容，失败为空串
 function _File.readFile(path) return '' end
 
 --- 写入文件
@@ -40,7 +40,7 @@ function _File.deleteAllFile(path) return true end
 
 --- 读取资源文件（res 目录）
 --- @param name string 文件名
---- @return string|nil 内容
+--- @return string 内容，失败为空串
 function _File.readResFile(name) return '' end
 
 --- 获取 res 资源的本地文件路径；用完后应调用 cleanupResFile
@@ -74,12 +74,12 @@ function _File.appendLine(path, data) return true end
 --- 读取指定行
 --- @param path string 路径
 --- @param lineNo integer 行号
---- @return string|nil 内容
+--- @return string 内容，失败为空串
 function _File.readLine(path, lineNo) return '' end
 
 --- 读取所有行
 --- @param path string 路径
---- @return string[] 行列表
+--- @return string[] 行列表，失败为空表
 function _File.readAllLines(path) return {} end
 
 --- 复制文件
@@ -90,7 +90,7 @@ function _File.copy(src, dest) return true end
 
 --- 计算文件MD5
 --- @param path string 路径
---- @return string|nil MD5值
+--- @return string MD5 值，失败为空串
 function _File.fileMD5(path) return '' end
 
 ---@type File

package/types/lua/global.lua

@@ -67,7 +67,7 @@ function Time() return 0 end
 ---@return string
 function ToJsonString(data) return '' end
 
---- 启动同 VM 协作协程（不是 OS 线程），返回协程名
+--- 启动协作协程，返回协程名
 ---@param func function
 ---@return string
 function StartThread(func) return '' end
@@ -76,7 +76,7 @@ function StartThread(func) return '' end
 ---@param threadName string
 function StopThread(threadName) end
 
---- 当前协作协程是否应退出。主脚本收到停止后由引擎 hook / Sleep 直接中断，不必轮询本函数。
+--- 当前协程是否应退出
 ---@return boolean
 function ShouldInterruptThread() return false end
 
@@ -121,18 +121,18 @@ function GetCpuThrottleDelay()
     return { minMs = 3, maxMs = 30 }
 end
 
---- 打印调试日志，等同 `logger.debug(...)`；可变参按空格拼接
+--- 打印调试日志，等同 `logger.debug(...)`
 ---@param ... any
 function logd(...) end
 
---- 打印信息日志，等同 `logger.info(...)`；可变参按空格拼接
+--- 打印信息日志，等同 `logger.info(...)`
 ---@param ... any
 function logi(...) end
 
---- 打印警告日志，等同 `logger.warn(...)`；可变参按空格拼接
+--- 打印警告日志，等同 `logger.warn(...)`
 ---@param ... any
 function logw(...) end
 
---- 打印错误日志，等同 `logger.error(...)`；可变参按空格拼接
+--- 打印错误日志，等同 `logger.error(...)`
 ---@param ... any
 function loge(...) end

package/types/lua/http.lua

@@ -4,7 +4,7 @@ local _Http = {}
 
 ---@class HttpRequestOptions
 ---@field url string         @请求地址
----@field timeout integer|nil @请求超时（毫秒）
+---@field timeout integer|nil @请求超时（毫秒），默认 30000
 ---@field method string|nil   @请求方法 GET/POST/...
 ---@field proxy {host:string, port:integer}|nil @代理服务器
 ---@field followRedirects boolean|nil @是否跟随重定向
@@ -47,7 +47,7 @@ end
 --- GET 请求（同名：httpGet）
 --- @param url string
 --- @param params table<string,string>|nil
---- @param timeout integer|nil
+--- @param timeout integer|nil 默认 30000
 --- @param headers table<string,string>|nil
 --- @return string|nil
 function _Http.httpGet(url, params, timeout, headers) return '' end
@@ -56,7 +56,7 @@ function _Http.httpGet(url, params, timeout, headers) return '' end
 --- @param url string
 --- @param params table<string,string>|nil
 --- @param files table<string,string>|nil
---- @param timeout integer|nil
+--- @param timeout integer|nil 默认 30000
 --- @param headers table<string,string>|nil
 --- @return string|nil
 function _Http.httpPost(url, params, files, timeout, headers) return '' end
@@ -64,7 +64,7 @@ function _Http.httpPost(url, params, files, timeout, headers) return '' end
 --- POST JSON 请求
 --- @param url string
 --- @param json table|nil
---- @param timeout integer|nil
+--- @param timeout integer|nil 默认 30000
 --- @param headers table<string,string>|nil
 --- @return string|nil
 function _Http.postJSON(url, json, timeout, headers) return '' end
@@ -72,7 +72,7 @@ function _Http.postJSON(url, json, timeout, headers) return '' end
 --- 下载文件（同名：downloadFile）
 --- @param url string
 --- @param file string
---- @param timeout integer|nil
+--- @param timeout integer|nil 默认 30000
 --- @param headers table<string,string>|nil
 --- @return boolean
 function _Http.downloadFile(url, file, timeout, headers) return true end

package/types/lua/image.lua

@@ -137,7 +137,7 @@ function _Image.cmpColor(id, points, threshold) return true end
 --- @param ey integer|nil 右下y
 --- @param threshold number 相似度 0.0-1.0
 --- @param limit integer|nil 限制个数
---- @param method integer|nil 匹配方法 0|1|3|5|99
+--- @param method integer|nil 匹配方法 0|1|3|5|99，默认 5
 --- @param rgb boolean|nil 是否使用RGB
 --- @param options FindImageOptions|nil 选项。scaleFactors 仅 method=99；orz 为查找方向 1-8
 --- @return Rect[] 结果矩形列表

package/types/lua/logger.lua

@@ -22,26 +22,22 @@ function _Logger.setMaxLogFileSize(size) end
 function _Logger.resetLogFile() end
 
 --- 输出调试日志（级别：debug）
---- 可变参数会按空格拼接为一行文本
---- @param ... any 日志内容（任意类型，自动调用 tostring）
+--- @param ... any 日志内容
 --- @return nil
 function _Logger.debug(...) end
 
 --- 输出信息日志（级别：info）
---- 可变参数会按空格拼接为一行文本
---- @param ... any 日志内容（任意类型，自动调用 tostring）
+--- @param ... any 日志内容
 --- @return nil
 function _Logger.info(...) end
 
 --- 输出警告日志（级别：warn）
---- 可变参数会按空格拼接为一行文本
---- @param ... any 日志内容（任意类型，自动调用 tostring）
+--- @param ... any 日志内容
 --- @return nil
 function _Logger.warn(...) end
 
 --- 输出错误日志（级别：error）
---- 可变参数会按空格拼接为一行文本
---- @param ... any 日志内容（任意类型，自动调用 tostring）
+--- @param ... any 日志内容
 --- @return nil
 function _Logger.error(...) end
 

package/types/lua/node.lua

@@ -40,7 +40,7 @@ local _Node = {}
 ---@field clickCenter fun(self: NodeInfo, duration: integer|nil): boolean 点击中心
 ---@field clickRandom fun(self: NodeInfo, duration: integer|nil): boolean 点击随机位置
 ---@field parent fun(self: NodeInfo): NodeInfo|nil 父节点
----@field child fun(self: NodeInfo, index: integer): NodeInfo|nil 子节点
+---@field child fun(self: NodeInfo, index: integer): NodeInfo|nil 子节点，index 从 0 开始
 ---@field allChildren fun(self: NodeInfo): NodeInfo[] 所有子节点
 ---@field siblings fun(self: NodeInfo): NodeInfo[] 所有兄弟节点
 ---@field previousSiblings fun(self: NodeInfo): NodeInfo[] 前兄弟节点

package/types/lua/system.lua

@@ -2,15 +2,10 @@
 ---@class System
 local _System = {}
 
----@class ProcessArguments
----@field env table<string, any> 环境变量映射（键为字符串，值为任意类型）
----@field args string[] 启动参数列表
-
 ---@class ActivateAppInfo
 ---@field name string 应用名称
 ---@field pid integer 进程 ID
 ---@field bundleId string 应用 Bundle ID
----@field processArguments ProcessArguments 启动参数信息
 
 ---@class MemoryInfo
 ---@field used integer 已使用内存（MB）
@@ -20,10 +15,8 @@ local _System = {}
 
 --- 启动应用
 --- @param bundleId string 应用 Bundle ID
---- @param args string[]|nil 启动参数
---- @param env table<string, any>|nil 环境变量
 --- @return boolean 成功
-function _System.startApp(bundleId, args, env) return true end
+function _System.startApp(bundleId) return true end
 
 --- 停止应用
 --- @param bundleId string 应用 Bundle ID

package/types/opencv.d.ts

@@ -274,8 +274,10 @@ declare namespace cv {
   function copyTo(mat: Mat, mask?: Mat | null): Mat | null;
 
   // ---- 颜色 / 运算 ----
+  /** 源图通道必须和转换码一致，例如 `COLOR_BGR2GRAY` 要 3 通道。 */
   function cvtColor(mat: Mat, code: number): Mat | null;
   function threshold(mat: Mat, options: ThresholdOptions): Mat | null;
+  /** 只接受 `CV_8UC1`。 */
   function adaptiveThreshold(mat: Mat, options: AdaptiveThresholdOptions): Mat | null;
   function inRange(mat: Mat, options: InRangeOptions): Mat | null;
   function bitwise_and(src1: Mat, options: BitwiseOptions): Mat | null;
@@ -285,7 +287,9 @@ declare namespace cv {
   function absdiff(src1: Mat, options: { src2: Mat }): Mat | null;
   function addWeighted(src1: Mat, options: { src2: Mat; alpha?: number; beta?: number; gamma?: number }): Mat | null;
   function convertScaleAbs(mat: Mat, options?: { alpha?: number; beta?: number }): Mat | null;
+  /** 只接受单通道 Mat；多通道返回 `-1`。 */
   function countNonZero(mat: Mat): number;
+  /** 只接受单通道 Mat；多通道返回 `null`。可选 `mask` 必须是 `CV_8UC1`。 */
   function minMaxLoc(mat: Mat, options?: { mask?: Mat }): MinMaxLocResult | null;
   function mean(mat: Mat, options?: { mask?: Mat }): number[] | null;
   function split(mat: Mat): Mat[] | null;
@@ -295,10 +299,13 @@ declare namespace cv {
   function GaussianBlur(mat: Mat, options: BlurOptions): Mat | null;
   function blur(mat: Mat, options: { ksize: number | [number, number] | Size }): Mat | null;
   function medianBlur(mat: Mat, options: { ksize: number }): Mat | null;
+  /** 只接受 1 或 3 通道，深度 `CV_8U` 或 `CV_32F`。 */
   function bilateralFilter(mat: Mat, options: { d?: number; sigmaColor?: number; sigmaSpace?: number }): Mat | null;
+  /** 只接受 8 位图（`CV_8U`，1/3/4 通道均可）。 */
   function Canny(mat: Mat, options: CannyOptions): Mat | null;
   function Sobel(mat: Mat, options: { ddepth?: number; dx?: number; dy?: number; ksize?: number; scale?: number; delta?: number }): Mat | null;
   function Laplacian(mat: Mat, options: { ddepth?: number; ksize?: number; scale?: number; delta?: number }): Mat | null;
+  /** 只接受 `CV_8UC1`。 */
   function equalizeHist(mat: Mat): Mat | null;
 
   // ---- 几何 / 绘制 ----
@@ -507,6 +514,7 @@ declare namespace cv {
   /** ORB 检测并计算描述子（二进制描述子，匹配常用 NORM_HAMMING） */
   function ORB(mat: Mat, options?: ORBOptions): FeatureResult | null;
   /** FAST 仅返回关键点（无描述子） */
+  /** 只接受 `CV_8UC1`。 */
   function FAST(mat: Mat, options?: FASTOptions): { keypoints: KeyPoint[] } | null;
 
   /** 暴力匹配描述子，返回 DMatch 数组 */
@@ -542,6 +550,7 @@ declare namespace cv {
   /** 就地洪水填充，返回填充像素数与外接矩形 */
   function floodFill(mat: Mat, options: FloodFillOptions): { filled: number; rect: Rect } | null;
   function convexHull(points: Point[], options?: { clockwise?: boolean }): Point[] | null;
+  /** Mat 输入必须是单通道栅格或 2 通道点集。 */
   function moments(matOrPoints: Mat | Point[], options?: { binaryImage?: boolean }): MomentsResult | null;
   function matchShapes(contour1: Mat | Point[], contour2: Mat | Point[], options?: { method?: number; parameter?: number }): number;
   function connectedComponentsWithStats(mat: Mat): ConnectedComponentsResult | null;