@solazah/solazah-runtime 0.2.20 → 0.2.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solazah/solazah-runtime",
-  "version": "0.2.20",
+  "version": "0.2.21",
   "main": "index.cjs",
   "module": "index.js",
   "types": "types/index.d.ts",

package/types/SystemRecorder.d.ts

@@ -6,8 +6,10 @@ export interface RecorderStartOptions {
     stopKey?: number;
     /** 时长上限,缺省 10 分钟 */
     maxMs?: number;
-    /** 以管理员身份录制:经 UAC 拉起助手进程,能录到提权程序(游戏等)的画面与操作;用户在授权框上取消就抛错 */
+    /** 以管理员身份收输入:经 UAC 拉起助手进程,能录到提权程序(游戏等)里的操作;用户在授权框上取消就抛错 */
     elevated?: boolean;
+    /** 合成输入(本产品或别的程序注入的点击与按键)也录进去,缺省只录真人的输入。助理自己演示一遍时用 */
+    injected?: boolean;
 }
 export interface RecorderStatus {
     supported: boolean;
@@ -16,8 +18,10 @@ export interface RecorderStatus {
     elapsedMs: number;
     events: number;
     frames: number;
-    /** 这次录制带管理员权限 */
+    /** 输入由带管理员权限的钩子在收 */
     elevated: boolean;
+    /** 合成输入也在录 */
+    injected: boolean;
 }
 export interface RecorderCapabilities {
     supported: boolean;
@@ -35,8 +39,12 @@ export interface RecorderResult {
     events: number;
     frames: number;
     durationMs: number;
-    stoppedBy: "hotkey" | "api" | "timeout";
+    /** error 是录制中途出了错(截不到画面、提权助手退出),原因在 error;轨迹照样写到出错那一刻 */
+    stoppedBy: "hotkey" | "api" | "timeout" | "error";
+    error: string | null;
+    /** 录制的任何一段输入由带管理员权限的钩子收 */
     elevated: boolean;
+    injected: boolean;
 }
 export default class SystemRecorder {
     private transport;
@@ -44,13 +52,14 @@ export default class SystemRecorder {
     /**
      * 开始录制用户操作:低层钩子收鼠标键盘、定时截主屏,每个按下/抬起/按键带上前后帧与那一刻的前台窗口。
      * 只记事实,不做任何手势归并;录制期间每一拍向发起方视图推 `recorder.progress`(RecorderStatus),
-     * 收尾(F12、超时、stop)写完轨迹后推一次 `recorder.stopped`(RecorderResult),用 ipcRenderer.on 接;
-     * 录制没有产物就中断了(管理员助手退出)只推一次 active=false 的 `recorder.progress`。
+     * 收尾(F12、超时、stop、出错)写完轨迹后推一次 `recorder.stopped`(RecorderResult),用 ipcRenderer.on 接;
+     * 出错结束的 stoppedBy 是 "error",原因在 error 里。
      * 产物落在**本插件的设备空间**里 recordings/<id>/:trajectory.json + frames/*.jpg —— 录到的是整屏画面
      * 与窗口标题,只属于这台设备,不进工作空间;用 window.file 的 `devicespace` 分类按同样的相对路径读写。
      *
-     * @param options `{fps?, stopKey?, maxMs?, elevated?}`,缺省 4 帧/秒、F12 结束、10 分钟上限;
-     *   elevated 为真时经 UAC 申请管理员权限,先用 capabilities() 看要不要。
+     * @param options `{fps?, stopKey?, maxMs?, elevated?, injected?}`,缺省 4 帧/秒、F12 结束、10 分钟上限;
+     *   elevated 为真时经 UAC 申请管理员权限,先用 capabilities() 看要不要;画面一律由宿主截。
+     *   injected 为真时合成输入也录进去(助理自己演示时用);任务回放这类合成输入缺省不进轨迹。
      * @returns `{id, dir, relPath, elevated}`。
      * @throws 平台不支持(目前仅 Windows)、已有录制在进行、钩子安装失败、用户在授权框上取消时抛错。
      */
@@ -60,15 +69,22 @@ export default class SystemRecorder {
         relPath: string;
         elevated: boolean;
     }>;
+    /**
+     * 录到一半申请管理员权限:经 UAC 拉起助手,之后的输入由它收,画面与时间轴不断。
+     *
+     * @returns 换过之后的录制状态;已经带管理员权限就原样返回。
+     * @throws 没有进行中的录制、用户在授权框上取消时抛错(录制照常继续)。
+     */
+    elevate: () => Promise<RecorderStatus>;
     /**
      * 结束录制并写出轨迹。按 stopKey 结束的录制不必再调。
      *
-     * @returns `{id, dir, relPath, events, frames, durationMs, stoppedBy, elevated}`。
+     * @returns `{id, dir, relPath, events, frames, durationMs, stoppedBy, error, elevated, injected}`。
      * @throws 没有进行中的录制时抛错。
      */
     stop: () => Promise<RecorderResult>;
     /**
-     * 录制状态:是否支持、是否进行中、已录事件数与帧数、是否带管理员权限。
+     * 录制状态:是否支持、是否进行中、已录事件数与帧数、是否带管理员权限、是否在录合成输入。
      */
     status: () => Promise<RecorderStatus>;
     /**