ms-types 0.0.65 → 0.0.66

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

@@ -5,7 +5,8 @@
 declare namespace $文件 {
   /**
    * 获取应用内部目录
-   * @param 目录类型
+   * @param 目录类型 documents 文档目录 library 库目录 temp 临时目录 libraryCaches 库缓存目录
+   * @description 一般使用documents目录，其他目录不常用 documents目录下的文件，会在我的文件中显示
    * @returns 目录路径
    * @example $文件.获取内部目录("documents")
    */
@@ -68,11 +69,7 @@ declare namespace $文件 {
    * @returns 是否删除成功
    * @example $文件.删除指定行("config.json", 1, null)
    */
-  function 删除指定行(
-    文件路径: 字符串,
-    行号: 数字,
-    包含内容: 字符串 | null
-  ): 布尔值;
+  function 删除指定行(文件路径: 字符串, 行号: 数字, 包含内容?: 字符串): 布尔值;
   /**
    * 列出目录下所有文件
    * @param 目录路径

package/types/zh//346/226/207/345/255/227/350/275/254/350/257/255/351/237/263/346/250/241/345/235/227.d.ts

@@ -0,0 +1,92 @@
+/// <reference path="全局模块.d.ts" />
+/**
+ * TTS（文本转语音）模块 包含语音合成、播放控制等功能
+ */
+declare namespace $文字转语音 {
+  /**
+   * 语音信息接口
+   */
+  interface 语音信息结构 {
+    /** 语音标识符 */
+    identifier: 字符串;
+    /** 语音名称 */
+    name: 字符串;
+    /** 语言代码 */
+    language: 字符串;
+    /** 语音质量等级 */
+    quality: 数字;
+  }
+
+  /**
+   * 播放文本转语音（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 是否成功 = $文字转语音.播放语音("你好世界", 0.5, 1.0, 1.0, "zh-CN");
+   */
+  function 播放语音(
+    text: 字符串,
+    rate?: 数字,
+    pitch?: 数字,
+    volume?: 数字,
+    language?: 字符串
+  ): 布尔值;
+
+  /**
+   * 等待当前语音播放结束
+   * @example
+   * $文字转语音.等待播放结束();
+   */
+  function 等待播放结束(): void;
+
+  /**
+   * 停止当前播放
+   * @example
+   * $文字转语音.停止播放();
+   */
+  function 停止播放(): void;
+
+  /**
+   * 检查是否正在播放
+   * @returns 是否正在播放
+   * @example
+   * if ($文字转语音.是否正在播放()) {
+   *   $打印信息日志("正在播放");
+   * }
+   */
+  function 是否正在播放(): 布尔值;
+
+  /**
+   * 获取可用的语音列表
+   * @returns 语音信息数组
+   * @example
+   * const 语音列表 = $文字转语音.获取可用的语音列表();
+   * 语音列表.forEach(语音信息 => {
+   *   $打印信息日志(`语音: ${语音信息.name}, 语言: ${语音信息.language}, 标识符: ${语音信息.identifier}, 质量: ${语音信息.quality}`);
+   * });
+   */
+  function 获取可用的语音列表(): 数组<语音信息结构>;
+
+  /**
+   * 设置语音
+   * @param 语音标识符
+   * @returns 是否设置成功
+   * @example
+   * const 是否成功 = $文字转语音.设置播报音色("com.apple.ttsbundle.siri_Yu-shu_zh-CN_compact");
+   * if (是否成功) {
+   *   $打印信息日志("语音设置成功");
+   * }
+   */
+  function 设置播报音色(语音标识符: 字符串): 布尔值;
+
+  /**
+   * 释放TTS资源（调用时，会停止当前播放并释放资源）
+   * @example
+   * $文字转语音.释放TTS资源();
+   */
+  function 释放TTS资源(): 无返回值;
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 日志模块 包含日志输出、日志等级设置等功能
+ */
+declare namespace $日志 {
+  /**
+   * 设置日志等级 开发环境默认debug 打包后默认info 可选值error、warn、debug、info、off
+   * @param level 日志等级
+   * @example
+   * $日志.设置日志级别("info");
+   */
+  function 设置日志级别(
+    日志等级: "error" | "warn" | "debug" | "info" | "off"
+  ): 无返回值;
+  /**
+   * 设置是否输出到文件 默认开启
+   * @param enabled 是否输出到文件
+   * @example
+   * $日志.设置日志保存到文件(true);
+   */
+  function 设置日志保存到文件(是否开启: 布尔值): 无返回值;
+  /**
+   * 重置日志文件 会创建一个新的日志文件 避免一个日志文件太大
+   * @example
+   * $日志.重置日志文件();
+   */
+  function 重置日志文件(): 无返回值;
+  /**
+   * 调试日志
+   * @param 日志内容
+   * @example
+   * $日志.调试输出("调试日志");
+   */
+  function 调试输出(...日志内容: 数组<任意类型>): 无返回值;
+
+  /**
+   * 信息日志
+   * @param 日志内容
+   * @example
+   * $日志.信息输出("信息日志");
+   */
+  function 信息输出(...日志内容: 数组<任意类型>): 无返回值;
+  /**
+   * 警告日志
+   * @param 日志内容
+   * @example
+   * $日志.警告输出("警告日志");
+   */
+  function 警告输出(...日志内容: 数组<任意类型>): 无返回值;
+  /**
+   * 错误日志
+   * @param 日志内容
+   * @example
+   * $日志.错误输出("错误日志");
+   */
+  function 错误输出(...日志内容: 数组<任意类型>): 无返回值;
+}

package/types/zh//347/203/255/346/233/264/346/226/260/346/250/241/345/235/227.d.ts

@@ -0,0 +1,105 @@
+/// <reference path="全局模块.d.ts" />
+
+declare namespace $热更新 {
+  /**
+   * 热更新检查结果
+   */
+  interface 热更新检查结果 {
+    /** 是否需要更新 */
+    needUpdate: 布尔值;
+    /** 错误信息（当检查失败时） */
+    error?: 字符串;
+    /** 服务器返回的更新数据（当 needUpdate 为 true 时） */
+    data?: 热更新服务器响应数据结构;
+  }
+
+  /**
+   * 热更新服务器响应数据结构
+   */
+  interface 热更新服务器响应数据结构 {
+    /** 新包的下载地址 */
+    download_url: 字符串;
+    /** 新包的版本号 */
+    version: 数字;
+    /** 下载msbundle文件超时时间（秒） */
+    download_timeout: 数字;
+    /** 是否用对话框的形式展示 */
+    dialog: 布尔值;
+    /** 对话框中要显示的消息 */
+    msg: 字符串;
+    /** 对话框模式下是否强制更新 */
+    force: 布尔值;
+    /** 更新包文件的MD5值，用于校验文件完整性 */
+    md5?: 字符串;
+  }
+
+  /**
+   * 热更新配置选项
+   */
+  interface 热更新参数 {
+    /** 检查更新的服务器URL，未提供时从 package.json 的 update.url 读取 */
+    url?: 字符串;
+    /** 当前版本号，未提供时从 package.json 的 appVersion 读取 */
+    version?: 数字;
+    /** 超时时间（毫秒），未提供时从 package.json 的 update.timeout 读取，默认10000毫秒 */
+    timeout?: 数字;
+  }
+
+  /**
+   * 检查更新（同步调用）
+   * @param options 更新配置选项（可选，不传则从package.json读取配置）
+   * @returns 检查结果
+   *
+   * @example
+   * // 检查更新（使用默认配置）
+   * const 热更新检查结果 = $热更新.检查更新();
+   *
+   * // 或者传入自定义配置
+   * const 热更新检查结果2 = $热更新.检查更新({
+   *   url: 'https://api.example.com/check-update'
+   * });
+   *
+   * if (热更新检查结果.needUpdate) {
+   *   $打印信息日志('发现新版本');
+   *   // 手动决定是否更新
+   *   const 安装结果 = $热更新.下载并安装更新包();
+   *   $打印信息日志('安装结果:', 安装结果);
+   * } else {
+   *   $打印错误日志('检查更新失败:', 热更新检查结果.error);
+   * }
+   */
+  function 检查更新(参数?: 热更新参数): 热更新检查结果;
+
+  /**
+   * 手动下载并安装更新, 执行成功后会自动重启脚本
+   * @returns 安装结果
+   * @example
+   * ```javascript
+   * const 热更新检查结果 = $热更新.检查更新();
+   * if (热更新检查结果.needUpdate) {
+   *   const 安装结果 = $热更新.下载并安装更新包();
+   *   if (安装结果.updated) {
+   *     $打印信息日志('更新安装成功');
+   *   } else {
+   *     $打印错误日志('更新安装失败:', 安装结果.error);
+   *   }
+   * }
+   * ```
+   */
+  function 下载并安装更新包(): {
+    /** 是否成功更新 */
+    updated: 布尔值;
+    /** 错误信息（当更新失败时） */
+    error?: 字符串;
+  };
+
+  /**
+   * 获取当前应用版本号
+   * 从 package.json 文件中读取 appVersion 字段并返回数字类型版本号
+   * @returns {number} 当前版本号，如果获取失败则返回 0
+   * @example
+   * const 版本号 = $热更新.获取当前版本号();
+   * $打印信息日志('当前版本:', 版本号); // 输出: 当前版本: 123
+   */
+  function 获取当前版本号(): 数字;
+}

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

@@ -0,0 +1,193 @@
+/// <reference path="全局模块.d.ts" />
+/**
+ * 系统模块 包含系统操作、系统信息等功能
+ */
+declare namespace $系统 {
+  /**
+   * 启动应用
+   * @param bundleId 应用bundleId
+   * @param args 应用参数
+   * @param env 应用环境变量
+   * @returns 是否启动成功
+   * @example
+   * const 是否启动成功 = $系统.启动应用("cn.magicnode.script", [], {})
+   * if (是否启动成功) {
+   *   $打印信息日志("启动成功")
+   * }
+   */
+  function 启动应用(
+    bundleId: 字符串,
+    args: 字符串[],
+    env: 字典<任意类型>
+  ): 布尔值;
+  /**
+   * 关闭应用
+   * @param bundleId 应用bundleId
+   * @returns 是否关闭成功
+   * @example
+   * const 是否关闭成功 = $系统.关闭应用("cn.magicnode.script")
+   * if (是否关闭成功) {
+   *   $打印信息日志("关闭成功")
+   * }
+   */
+  function 关闭应用(bundleId: 字符串): 布尔值;
+  /**
+   * 激活应用 没启动就会启动 启动了就会进入前台
+   * @param bundleId 应用bundleId
+   * @returns 是否激活成功
+   * @example
+   * const 是否激活成功 = $系统.把应用切入前台("cn.magicnode.script")
+   * if (是否激活成功) {
+   *   $打印信息日志("激活成功")
+   * }
+   */
+  function 把应用切入前台(bundleId: 字符串): 布尔值;
+  /**
+   * 获取当前在前台的应用信息
+   * @returns 当前在前台的应用信息
+   * @example
+   * const info = $系统.获取当前运行的应用()
+   * if (info) {
+   *   $打印信息日志(info.name)
+   * }
+   */
+  function 获取当前运行的应用(): {
+    bundleId: 字符串;
+    name: 字符串;
+    pid: 数字;
+    processArguments: {
+      env: 字典<任意类型>;
+      args: 字符串[];
+    };
+  } | null;
+  /**
+   * 获取系统是否锁屏
+   * @returns 是否锁屏
+   * @example
+   * const 是否锁屏 = $系统.是否锁屏()
+   * if (是否锁屏) {
+   *   $打印信息日志("锁屏")
+   * }
+   */
+  function 是否锁屏(): boolean;
+  /**
+   * 锁屏
+   * @returns 是否锁屏成功
+   * @example
+   * const 是否锁屏成功 = $系统.锁屏()
+   * if (是否锁屏成功) {
+   *   $打印信息日志("锁屏成功")
+   * }
+   */
+  function 锁屏(): boolean;
+  /**
+   * 解锁 如果有密码 会停在解锁界面
+   * @returns 是否解锁成功
+   * @example
+   * const 是否解锁成功 = $系统.解锁()
+   * if (是否解锁成功) {
+   *   $打印信息日志("解锁成功")
+   * }
+   */
+  function 解锁(): boolean;
+  /**
+   * 设置剪贴板 APP 在前台运行时才能设置
+   * @param text 剪贴板内容
+   * @returns 是否设置成功
+   * @example
+   * const 是否设置成功 = $系统.设置剪切板内容("hello")
+   * if (是否设置成功) {
+   *   $打印信息日志("设置成功")
+   * }
+   */
+  function 设置剪切板内容(文本: 字符串): 布尔值;
+  /**
+   * 获取剪贴板
+   * @returns 剪贴板内容
+   * @example
+   * const 剪贴板内容 = $系统.获取剪切板内容()
+   * if (剪贴板内容) {
+   *   $打印信息日志(剪贴板内容)
+   * }
+   */
+  function 获取剪切板内容(): 字符串 | null;
+  /**
+   * 打开URL
+   * @param url URL
+   * @returns 是否打开成功
+   * @example
+   * const 是否打开成功 = $系统.打开URL("https://www.baidu.com")
+   * if (是否打开成功) {
+   *   $打印信息日志("打开成功")
+   * }
+   */
+  function 打开URL(URL: 字符串): 布尔值;
+  /**
+   * 通知
+   * @param msg 通知内容
+   * @param title 通知标题
+   * @param id 通知id 通知id相同的会被覆盖
+   * @example
+   * $系统.发送系统通知("通知内容", "通知标题", "1111")
+   */
+  function 发送系统通知(消息: 字符串, 标题?: 字符串, 通知ID?: 字符串): 无返回值;
+  /**
+   * 获取内存使用信息
+   * @returns 内存使用信息，包含已使用内存、可用内存、总内存和使用率（单位：MB）
+   * @example
+   * const 内存信息 = $系统.获取内存使用信息()
+   * $打印信息日志(`已使用: ${内存信息.used}MB, 可用: ${内存信息.available}MB, 总计: ${内存信息.total}MB, 使用率: ${内存信息.usagePercentage}%`)
+   */
+  function 获取内存使用信息(): {
+    used: 数字;
+    available: 数字;
+    total: 数字;
+    usagePercentage: 数字;
+  };
+  /**
+   * 获取已使用内存
+   * @returns 已使用内存大小（单位：MB）
+   * @example
+   * const 已使用内存 = $系统.获取已使用内存()
+   * $打印信息日志(`已使用内存: ${已使用内存}MB`)
+   */
+  function 获取已使用内存(): number;
+  /**
+   * 获取可用内存
+   * @returns 可用内存大小（单位：MB）
+   * @example
+   * const 可用内存 = $系统.获取可用内存()
+   * $打印信息日志(`可用内存: ${可用内存}MB`)
+   */
+  function 获取可用内存(): number;
+  /**
+   * 获取系统总内存
+   * @returns 系统总内存大小（单位：MB）
+   * @example
+   * const 总内存 = $系统.获取系统总内存()
+   * $打印信息日志(`系统总内存: ${总内存}MB`)
+   */
+  function 获取系统总内存(): number;
+  /**
+   * 启动 WDA 服务
+   * @returns 是否启动成功
+   * @example
+   * const 是否启动成功 = $系统.启动WDA服务()
+   * if (是否启动成功) {
+   *   $打印信息日志("WDA 启动成功")
+   * }
+   */
+  function 启动WDA服务(): boolean;
+  /**
+   * 获取 WDA 状态
+   * @returns WDA 是否正在运行
+   * @example
+   * const 是否运行 = $系统.获取WDA状态()
+   * if (是否运行) {
+   *   $打印信息日志("WDA 服务正在运行")
+   * } else {
+   *   $打印信息日志("WDA 服务未运行")
+   * }
+   */
+  function 获取WDA状态(): boolean;
+}

package/types/zh//347/272/277/347/250/213/346/250/241/345/235/227.d.ts

@@ -0,0 +1,102 @@
+/// <reference path="全局模块.d.ts" />
+/**
+ * 线程模块 包含线程操作、线程回调等功能
+ */
+declare namespace $线程 {
+  /**
+   * 异步执行线程代码
+   * @param 线程js文件路径
+   * @param 回调函数名称
+   * @param 回调函数
+   * @returns 线程名称
+   * @example
+   * const 线程名称 = $线程.执行异步代码("xxx_thread.js", "回调函数名称", (数据) => {
+   *   $打印信息日志(数据)
+   *   return "1111"
+   * })
+   *
+   * thread.js
+   * while (true) {
+   *   // 通知主线程并传递数据
+   *   const 回调返回值 = $线程.调用回调函数("回调函数名称", "hello world")
+   *   // 主线程返回数据
+   *   $打印信息日志(回调返回值)
+   *   $延时(1000)
+   * }
+   */
+  function 执行异步代码(
+    线程js文件路径: 字符串,
+    回调函数名称: 字符串,
+    回调函数: (数据?: 任意类型) => 任意类型
+  ): 字符串 | null;
+  /**
+   * 调用线程回调函数
+   * @param name 回调函数名称
+   * @param data 回调数据
+   * @returns 回调返回值
+   * @example
+   * const 回调返回值 = $线程.调用回调函数("回调函数名称", "hello world")
+   * $打印信息日志(回调返回值)
+   */
+  function 调用回调函数(回调函数名称: 字符串, 数据?: 任意类型): 任意类型;
+  /**
+   * 创建新线程
+   * @param 线程js文件路径
+   * @returns 线程对象
+   * @example
+   * const 新线程 = $线程.创建新线程("xxx_thread.js")
+   * 新线程.添加回调函数("callback", (数据) => {
+   *   $打印信息日志(数据)
+   *   return "1111"
+   * })
+   */
+  function 创建新线程(线程js文件路径: 字符串): {
+    /**
+     * 线程名称
+     */
+    name: 字符串;
+    /**
+     * 添加回调函数
+     * @param 回调函数名称
+     * @param 回调函数
+     * @returns 是否添加成功
+     */
+    添加回调函数: (
+      回调函数名称: 字符串,
+      回调函数: (数据?: 任意类型) => 任意类型
+    ) => 布尔值;
+  } | null;
+  /**
+   * 取消线程
+   * @param 线程名称
+   * @returns 是否取消成功
+   * @example
+   * const 新线程 = $线程.创建新线程("xxx_thread.js")
+   * 新线程.添加回调函数("回调函数名称", (数据) => {
+   *   $打印信息日志(数据)
+   *   return "1111"
+   * })
+   * $线程.取消线程(新线程.name)
+   */
+  function 取消线程(线程名称: 字符串): 布尔值;
+  /**
+   * 检查线程是否已取消
+   * @param 线程名称
+   * @returns 是否已取消
+   * @example
+   * const 新线程 = $线程.创建新线程("xxx_thread.js")
+   * 新线程.添加回调函数("回调函数名称", (数据) => {
+   *   $打印信息日志(数据)
+   *   return "1111"
+   * })
+   * $线程.线程是否已被取消(新线程.name)
+   */
+  function 线程是否已被取消(线程名称: 字符串): 布尔值;
+  /**
+   * 停止所有线程
+   * @returns 是否停止成功
+   * @example
+   * $线程.停止所有线程()
+   */
+  function 停止所有线程(): 布尔值;
+}