@bettergi/types 0.1.14 → 0.1.15

package/bindings/htmlMask.d.ts

@@ -1,3 +1,8 @@
+/**
+ * 脚本侧 HTML 遮罩全局（ClearScript 宿主对象）。
+ * 启用：`import "@bettergi/types/htmlMask/host"` 或整包 `@bettergi/types`。
+ * 遮罩页（WebView）侧见 `@bettergi/types/htmlMask/webview`。
+ */
 import "../types/BetterGenshinImpact/Core/Script/Dependence/HtmlMask";
 
 declare global {

package/bindings/htmlMask.webview.d.ts

@@ -0,0 +1,92 @@
+/**
+ * HTML 遮罩页（WebView2）侧通信桥类型。
+ * 对应宿主 `HtmlMaskWindow` 在 DocumentCreated 时注入的 helper，
+ * 与脚本侧 `@bettergi/types/htmlMask/host`（ClearScript `htmlMask` 全局）相对。
+ *
+ * 启用：`import "@bettergi/types/htmlMask/webview"` 或
+ * `/// <reference types="@bettergi/types/htmlMask/webview" />`
+ *
+ * @see BetterGenshinImpact.View.HtmlMaskWindow
+ * @since 0.61.0
+ */
+
+/**
+ * 遮罩页与脚本之间的消息信封
+ * 宿主 JSON 使用 camelCase（url / data / requestId）
+ * @since 0.61.0
+ */
+export interface HtmlMaskWebViewMessage {
+  /** 消息路径；页→脚本的 request 与脚本→页的推送均使用 */
+  url?: string;
+  /** 业务载荷；解析失败时可能不存在 */
+  data?: unknown;
+  /**
+   * 请求-应答关联 ID
+   * - 页发起 request 时由注入脚本生成（`__req_*`）
+   * - 脚本发起 request 时由宿主生成；页 onMessage 若返回值非 undefined 则自动回传
+   */
+  requestId?: string;
+}
+
+/**
+ * 注入到遮罩页的 `window.htmlMask` 助手
+ * 内部还含 `_callbacks` / `_seq` / `_dispatch`，属实现细节，不纳入公开类型
+ * @since 0.61.0
+ */
+export interface HtmlMaskWebView {
+  /**
+   * 向脚本侧发起请求并等待响应
+   * 经 `chrome.webview.postMessage` 送出 `{ url, data, requestId }`；
+   * 匹配到带同一 requestId 的入站消息后 resolve 整包对象
+   * @param url 消息路径
+   * @param data 载荷，省略时按 `{}` 发送
+   * @since 0.61.0
+   */
+  request(url: string, data?: unknown): Promise<HtmlMaskWebViewMessage>;
+
+  /**
+   * 脚本推送到页的消息回调
+   * - 入站 JSON 解析成功：参数为消息对象
+   * - 解析失败：参数为原始字符串，且仍调用本回调
+   * - 若消息带 `requestId` 且返回值不是 `undefined`，助手会将结果
+   *   （支持 Promise）以 `{ requestId, url: "/__response__", data }` 回传脚本
+   * @since 0.61.0
+   */
+  onMessage: ((msg: HtmlMaskWebViewMessage | string) => unknown) | null;
+}
+
+/**
+ * WebView2 提供的 `chrome.webview` 子集（遮罩页实际使用的面）
+ * @since 0.61.0
+ */
+export interface ChromeWebView {
+  /**
+   * 向宿主发送字符串消息（须为 JSON 文本）
+   * @since 0.61.0
+   */
+  postMessage(message: string): void;
+  /**
+   * 监听宿主 `PostWebMessageAsString` 推送
+   * @since 0.61.0
+   */
+  addEventListener(type: "message", listener: (event: { data: string }) => void): void;
+}
+
+declare global {
+  interface Window {
+    /**
+     * HTML 遮罩页通信桥（宿主注入；非宿主环境可能不存在）
+     * @since 0.61.0
+     */
+    htmlMask?: HtmlMaskWebView;
+    /**
+     * WebView2 宿主对象；仅 WebView 内可用
+     * @since 0.61.0
+     */
+    chrome?: {
+      webview?: ChromeWebView;
+    };
+  }
+}
+
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bettergi/types",
-  "version": "0.1.14",
+  "version": "0.1.15",
   "description": "BetterGI TypeScript 类型定义",
   "type": "module",
   "author": "Bread Grocery<https://github.com/breadgrocery>",
@@ -18,6 +18,12 @@
   "exports": {
     ".": {
       "types": "./index.d.ts"
+    },
+    "./htmlMask/host": {
+      "types": "./bindings/htmlMask.d.ts"
+    },
+    "./htmlMask/webview": {
+      "types": "./bindings/htmlMask.webview.d.ts"
     }
   },
   "files": [

package/types/BetterGenshinImpact/Core/Script/Dependence/KeyMouseHook.d.ts

@@ -6,15 +6,16 @@ import type {
   ReferenceTypeTrait,
   StrongNumeric
 } from "../../../../Microsoft/ClearScript/HostType";
-import "../../../../Microsoft/ClearScript/ScriptObject";
 import type { VoidResult } from "../../../../Microsoft/ClearScript/VoidResult";
 import "../../../../System/IDisposable";
+import type { Keys } from "../../../../System/Windows/Forms/Keys";
 
 /**
  * 钩子回报的鼠标按键
  * @since 0.55.0
  */
 export type MouseButton =
+  | "None"
   | "Left" // 左键
   | "Right" // 右键
   | "Middle" // 中键
@@ -36,8 +37,9 @@ export interface KeyMouseHook extends ClrHostValue, System.IDisposableInput {
    * @returns ClearScript 宿主空结果
    * @since 0.55.0
    */
-  onKeyDown(callback: Microsoft.ClearScript.ScriptObject): VoidResult;
-  onKeyDown(callback: Microsoft.ClearScript.ScriptObject, useCodeOnly: boolean): VoidResult;
+  onKeyDown(callback: (keyCode: Keys) => void): VoidResult;
+  onKeyDown(callback: (keyCode: Keys) => void, useCodeOnly: true): VoidResult;
+  onKeyDown(callback: string, useCodeOnly: false): VoidResult;
   /**
    * 注册键盘释放事件回调
    * @param callback 回调函数
@@ -45,22 +47,23 @@ export interface KeyMouseHook extends ClrHostValue, System.IDisposableInput {
    * @returns ClearScript 宿主空结果
    * @since 0.55.0
    */
-  onKeyUp(callback: Microsoft.ClearScript.ScriptObject): VoidResult;
-  onKeyUp(callback: Microsoft.ClearScript.ScriptObject, useCodeOnly: boolean): VoidResult;
+  onKeyUp(callback: (keyCode: Keys) => void): VoidResult;
+  onKeyUp(callback: (keyCode: Keys) => void, useCodeOnly: true): VoidResult;
+  onKeyUp(callback: string, useCodeOnly: false): VoidResult;
   /**
    * 注册鼠标按下事件回调
    * @param callback 回调，参数为按键名与游戏窗口局部坐标
    * @returns ClearScript 宿主空结果
    * @since 0.55.0
    */
-  onMouseDown(callback: (button: MouseButton, x: number, y: number) => void): VoidResult;
+  onMouseDown(callback: (button: MouseButton, localX: number, localY: number) => void): VoidResult;
   /**
    * 注册鼠标抬起事件回调
    * @param callback 回调，参数为按键名与游戏窗口局部坐标
    * @returns ClearScript 宿主空结果
    * @since 0.55.0
    */
-  onMouseUp(callback: (button: MouseButton, x: number, y: number) => void): VoidResult;
+  onMouseUp(callback: (button: MouseButton, localX: number, localY: number) => void): VoidResult;
   /**
    * 注册鼠标移动事件回调
    * @param callback 回调函数

package/types/BetterGenshinImpact/Core/Script/Dependence/Model/SoloTask.d.ts

@@ -4,22 +4,84 @@ import type {
   ReferenceTypeTrait
 } from "../../../../../Microsoft/ClearScript/HostType";
 import "../../../../../Microsoft/ClearScript/ScriptObject";
+import "../../../../GameTask/Common/Job/CountInventoryItemParam";
+import "../../../../GameTask/Model/GameUI/GridScreenName";
 
 /**
- * 独立任务注册名
+ * 任务名 → SoloTask.Config（唯一真源；配置一律 inline，无额外 type 名）
+ * @see Dispatcher.RunTask switch / BuildFromSoloTaskConfig
+ * @since 0.43.1
+ */
+export type SoloTaskConfigMap = {
+  /** 自动七圣召唤  */
+  AutoGeniusInvokation: {
+    /** 七圣策略文本；空则回退 UI 设置 */
+    strategy?: string;
+  };
+  /** 自动伐木 */
+  AutoWood: void;
+  /** 自动战斗 */
+  AutoFight: void;
+  /** 自动秘境 */
+  AutoDomain: void;
+  /** 自动首领 */
+  AutoBoss: void;
+  /** 自动钓鱼 */
+  AutoFishing: {
+    wholeProcessTimeoutSeconds?: number;
+    throwRodTimeOutTimeoutSeconds?: number;
+    /**
+     * 钓鱼时间策略
+     * - 0 全天
+     * - 1 白天
+     * - 2 夜晚
+     * - 3 不调
+     */
+    fishingTimePolicy?: 0 | 1 | 2 | 3 | number;
+    /** 关键节拍是否保存截图（调试用）；默认 false */
+    saveScreenshotOnKeyTick?: boolean;
+  };
+  /** 自动烹饪 */
+  AutoCook: void;
+  /** 自动吃药 */
+  AutoEat: {
+    foodName?: string | null;
+    /**
+     * 料理类型
+     * - 0 恢复类料理
+     * - 1 攻击类料理
+     * - 2 冒险类料理
+     * - 3 防御类料理
+     * - 4 药剂
+     * - 5 其他
+     */
+    foodEffectType?: 0 | 1 | 2 | 3 | 4 | 5 | number;
+  };
+  /** 统计背包物品 */
+  CountInventoryItem: {
+    /**  gridScreenName 必填 */
+    gridScreenName:
+      | BetterGenshinImpact.GameTask.Common.Job.CountInventoryItemParam["gridScreenName"]
+      | number
+      | BetterGenshinImpact.GameTask.Model.GameUI.GridScreenName;
+    /** itemName 与 itemNames 互斥 */
+    itemName?: string | null;
+    itemNames?: readonly string[] | string[];
+  };
+};
+
+/**
+ * 独立任务注册名 = map key；`(string & {})` 保留未知扩展
  * @since 0.46.0
  */
-export type SoloTaskName =
-  | "AutoGeniusInvokation" // 自动七圣召唤
-  | "AutoWood" // 自动伐木
-  | "AutoFight" // 自动战斗
-  | "AutoDomain" // 自动秘境
-  | "AutoBoss" // 自动首领
-  | "AutoFishing" // 自动钓鱼
-  | "AutoCook" // 自动烹饪
-  | "AutoEat" // 自动食用
-  | "CountInventoryItem" // 统计背包物品
-  | (string & {});
+export type SoloTaskName = keyof SoloTaskConfigMap | (string & {});
+
+export type SoloTaskConfigForName<TName extends SoloTaskName> =
+  TName extends keyof SoloTaskConfigMap
+    ? SoloTaskConfigMap[TName] extends void
+      ? undefined
+      : SoloTaskConfigMap[TName]
+    : Record<string, unknown>;
 
 /**
  * 独立任务
@@ -34,10 +96,14 @@ export interface SoloTask extends ClrHostValue {
    */
   name: SoloTaskName;
   /**
-   * 独立任务配置
+   * 独立任务配置（CLR 存 `object?`，JS 侧 plain object）
    * @since 0.43.1
    */
-  config: unknown;
+  config:
+    | Exclude<SoloTaskConfigMap[keyof SoloTaskConfigMap], void>
+    | Record<string, unknown>
+    | null
+    | undefined;
 }
 
 declare global {
@@ -48,18 +114,21 @@ declare global {
 
 export interface SoloTaskHostType extends HostType<SoloTask, ReferenceTypeTrait> {
   /**
-   * 构造实例
-   * @param name 独立任务名称
+   * 仅名称
    * @since 0.43.1
    */
   new (name: SoloTaskName): SoloTask;
+
   /**
-   * 构造实例
-   * @param name 独立任务名称
-   * @param config 独立任务配置对象
+   * 名称 + 配置（按任务名收窄）
    * @since 0.43.1
    */
-  new (name: SoloTaskName, config: Microsoft.ClearScript.ScriptObject): SoloTask;
+  new <TName extends SoloTaskName>(
+    name: TName,
+    config: SoloTaskConfigForName<TName> extends undefined
+      ? Record<string, unknown> | undefined
+      : SoloTaskConfigForName<TName>
+  ): SoloTask;
 }
 
 export {};

package/types/System/Windows/Forms/Keys.d.ts

@@ -0,0 +1,195 @@
+export type Keys =
+  | "None"
+  | "LButton"
+  | "RButton"
+  | "Cancel"
+  | "MButton"
+  | "XButton1"
+  | "XButton2"
+  | "Back"
+  | "Tab"
+  | "LineFeed"
+  | "Clear"
+  | "Return"
+  | "Enter"
+  | "ShiftKey"
+  | "ControlKey"
+  | "Menu"
+  | "Pause"
+  | "Capital"
+  | "CapsLock"
+  | "KanaMode"
+  | "HanguelMode"
+  | "HangulMode"
+  | "JunjaMode"
+  | "FinalMode"
+  | "HanjaMode"
+  | "KanjiMode"
+  | "Escape"
+  | "IMEConvert"
+  | "IMENonconvert"
+  | "IMEAccept"
+  | "IMEAceept"
+  | "IMEModeChange"
+  | "Space"
+  | "Prior"
+  | "PageUp"
+  | "Next"
+  | "PageDown"
+  | "End"
+  | "Home"
+  | "Left"
+  | "Up"
+  | "Right"
+  | "Down"
+  | "Select"
+  | "Print"
+  | "Execute"
+  | "Snapshot"
+  | "PrintScreen"
+  | "Insert"
+  | "Delete"
+  | "Help"
+  | "D0"
+  | "D1"
+  | "D2"
+  | "D3"
+  | "D4"
+  | "D5"
+  | "D6"
+  | "D7"
+  | "D8"
+  | "D9"
+  | "A"
+  | "B"
+  | "C"
+  | "D"
+  | "E"
+  | "F"
+  | "G"
+  | "H"
+  | "I"
+  | "J"
+  | "K"
+  | "L"
+  | "M"
+  | "N"
+  | "O"
+  | "P"
+  | "Q"
+  | "R"
+  | "S"
+  | "T"
+  | "U"
+  | "V"
+  | "W"
+  | "X"
+  | "Y"
+  | "Z"
+  | "LWin"
+  | "RWin"
+  | "Apps"
+  | "Sleep"
+  | "NumPad0"
+  | "NumPad1"
+  | "NumPad2"
+  | "NumPad3"
+  | "NumPad4"
+  | "NumPad5"
+  | "NumPad6"
+  | "NumPad7"
+  | "NumPad8"
+  | "NumPad9"
+  | "Multiply"
+  | "Add"
+  | "Separator"
+  | "Subtract"
+  | "Decimal"
+  | "Divide"
+  | "F1"
+  | "F2"
+  | "F3"
+  | "F4"
+  | "F5"
+  | "F6"
+  | "F7"
+  | "F8"
+  | "F9"
+  | "F10"
+  | "F11"
+  | "F12"
+  | "F13"
+  | "F14"
+  | "F15"
+  | "F16"
+  | "F17"
+  | "F18"
+  | "F19"
+  | "F20"
+  | "F21"
+  | "F22"
+  | "F23"
+  | "F24"
+  | "NumLock"
+  | "Scroll"
+  | "LShiftKey"
+  | "RShiftKey"
+  | "LControlKey"
+  | "RControlKey"
+  | "LMenu"
+  | "RMenu"
+  | "BrowserBack"
+  | "BrowserForward"
+  | "BrowserRefresh"
+  | "BrowserStop"
+  | "BrowserSearch"
+  | "BrowserFavorites"
+  | "BrowserHome"
+  | "VolumeMute"
+  | "VolumeDown"
+  | "VolumeUp"
+  | "MediaNextTrack"
+  | "MediaPreviousTrack"
+  | "MediaStop"
+  | "MediaPlayPause"
+  | "LaunchMail"
+  | "SelectMedia"
+  | "LaunchApplication1"
+  | "LaunchApplication2"
+  | "OemSemicolon"
+  | "Oem1"
+  | "Oemplus"
+  | "Oemcomma"
+  | "OemMinus"
+  | "OemPeriod"
+  | "OemQuestion"
+  | "Oem2"
+  | "Oemtilde"
+  | "Oem3"
+  | "OemOpenBrackets"
+  | "Oem4"
+  | "OemPipe"
+  | "Oem5"
+  | "OemCloseBrackets"
+  | "Oem6"
+  | "OemQuotes"
+  | "Oem7"
+  | "Oem8"
+  | "OemBackslash"
+  | "Oem102"
+  | "ProcessKey"
+  | "Packet"
+  | "Attn"
+  | "Crsel"
+  | "Exsel"
+  | "EraseEof"
+  | "Play"
+  | "Zoom"
+  | "NoName"
+  | "Pa1"
+  | "OemClear"
+  | "Shift"
+  | "Control"
+  | "Alt";
+
+export {};