@bettergi/utils 0.0.5 → 0.0.7

package/README.md

@@ -8,6 +8,26 @@ npm install @bettergi/utils
 
 ## 函数清单
 
+### 游戏内操作
+
+> 常见游戏内操作封装，省去手动实现的繁琐。
+
+```ts
+import { openMenu, openMenuPage, openPaimonMenu, setTime } from "@bettergi/utils";
+
+// 打开派蒙菜单
+await openPaimonMenu();
+
+// 打开菜单
+await openMenu("邮件");
+
+// 打开菜单页面
+await openMenuPage("问卷");
+
+// 调整游戏时间
+await setTime("evening");
+```
+
 ### 图文识别
 
 > 对 RecognitionObject 代码的封装，对于简单的找图、找字操作，不再需要编写复杂的代码。
@@ -116,3 +136,16 @@ try {
   state.lastUsedTime = Date.now(); // 自动同步保存到文件
 }
 ```
+
+### 网络请求
+
+> 对网络请求的简易封装。
+
+```ts
+import { getForBody } from "@bettergi/utils";
+
+// 发送 GET 请求获取响应体内容
+// 提示：需要在 `manifest.json` 文件中配置 `http_allowed_urls`，并在 调度器 -> 修改通用配置 中启用
+const body = await getForBody("https://example.com/", undefined, { "User-Agent": "BetterGI" });
+log.info(`响应体内容${body}`);
+```

package/dist/flow.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 等待直到条件满足或超时
+ * @param condition 等待的条件判断函数，返回 true 表示条件满足
+ * @param timeout 超时时间（毫秒），默认 3000 毫秒
+ * @param interval 等待间隔（毫秒），默认 300 毫秒
+ * @param action 每次等待循环中执行的操作（可选）
+ * @returns - true  在超时前条件已满足
+ *          - false 在超时后条件仍未满足
+ */
+export declare const waitUntil: (condition: (context: Record<string, any>) => boolean, timeout?: number, interval?: number, action?: (context: Record<string, any>) => void) => Promise<boolean>;

package/dist/flow.js

@@ -0,0 +1,20 @@
+/**
+ * 等待直到条件满足或超时
+ * @param condition 等待的条件判断函数，返回 true 表示条件满足
+ * @param timeout 超时时间（毫秒），默认 3000 毫秒
+ * @param interval 等待间隔（毫秒），默认 300 毫秒
+ * @param action 每次等待循环中执行的操作（可选）
+ * @returns - true  在超时前条件已满足
+ *          - false 在超时后条件仍未满足
+ */
+export const waitUntil = async (condition, timeout, interval, action) => {
+    const context = {};
+    const deadline = Date.now() + (timeout ?? 3 * 1000);
+    while (Date.now() < deadline) {
+        if (condition(context))
+            return true;
+        action?.(context);
+        await sleep(interval ?? 300);
+    }
+    return false;
+};

package/dist/game.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 打开派蒙菜单
+ */
+export declare const openPaimonMenu: () => Promise<void>;
+/**
+ * 打开游戏菜单（左侧按钮）
+ * @param name 菜单名称
+ * @param reverse 是否反向搜索（可选）
+ * @param config 搜索参数（可选）
+ */
+export declare const openMenu: (name: "\u62CD\u7167" | "\u516C\u544A" | "\u90AE\u4EF6" | "\u65F6\u95F4" | "\u8BBE\u7F6E" | (string & {}), reverse?: boolean, config?: {
+    x?: number;
+    step?: number;
+    timeout?: number;
+}) => Promise<void>;
+/**
+ * 打开游戏菜单页面（菜单按钮列表）
+ * @param name 菜单页面名称
+ * @param config 菜单页面视图参数
+ */
+export declare const openMenuPage: (name: string, config?: {
+    x?: number;
+    y?: number;
+    w?: number;
+    h?: number;
+    lineHeight?: number;
+}) => Promise<void>;
+/**
+ * 调整游戏时间
+ * @param period 时间段
+ * @param config 时钟参数
+ */
+export declare const setTime: (period: "night" | "morning" | "noon" | "evening", config?: {
+    centerX?: number;
+    centerY?: number;
+    radius?: number;
+    offset?: number;
+}) => Promise<void>;

package/dist/game.js

@@ -0,0 +1,103 @@
+import { waitUntil } from "./flow";
+import { mouseSlide } from "./mouse";
+import { findTextInDirection, findTextWithinBounds, findTextWithinListView } from "./ocr";
+/**
+ * 打开派蒙菜单
+ */
+export const openPaimonMenu = async () => {
+    // 1.返回主界面
+    await genshin.returnMainUi();
+    // 2.打开派蒙菜单
+    const findWorldLevel = () => findTextInDirection("世界等级", false, true, "north-west");
+    const ok = await waitUntil(() => findWorldLevel() !== undefined, 5000, 1000, () => keyPress("ESCAPE"));
+    if (!ok)
+        throw new Error("打开派蒙菜单超时");
+};
+/**
+ * 打开游戏菜单（左侧按钮）
+ * @param name 菜单名称
+ * @param reverse 是否反向搜索（可选）
+ * @param config 搜索参数（可选）
+ */
+export const openMenu = async (name, reverse, config) => {
+    // 1.打开派蒙菜单
+    await openPaimonMenu();
+    // 2.搜索菜单按钮
+    const { x = 50, step = 30, timeout = 3000 } = config || {};
+    const findTooltip = () => findTextWithinBounds(name, false, true, 0, 0, x + 150, genshin.height);
+    let result = undefined;
+    const steps = Math.ceil(genshin.height / step);
+    for (let i = 0; i < steps; i++) {
+        const o = i * step;
+        const y = reverse ? genshin.height - o : o;
+        moveMouseTo(x, y);
+        await sleep(30);
+        if ((result = findTooltip()) !== undefined)
+            break;
+    }
+    // 3.点击菜单按钮
+    if (result != undefined) {
+        const ok = await waitUntil(() => findTooltip() === undefined, timeout, 1000, () => {
+            click(x, result.y);
+        });
+        if (!ok)
+            throw new Error(`打开菜单 ${name} 超时`);
+    }
+    else {
+        throw new Error(`打开菜单 ${name} 失败`);
+    }
+};
+/**
+ * 打开游戏菜单页面（菜单按钮列表）
+ * @param name 菜单页面名称
+ * @param config 菜单页面视图参数
+ */
+export const openMenuPage = async (name, config) => {
+    // 1.打开派蒙菜单
+    await openPaimonMenu();
+    // 2.搜索菜单页面
+    const { x = 100, y = 330, w = 670, h = 730, lineHeight = 142 } = config || {};
+    const pageButton = await findTextWithinListView(name, false, true, {
+        x,
+        y,
+        w,
+        h,
+        maxListItems: 5,
+        lineHeight
+    });
+    if (!pageButton)
+        throw new Error(`搜索菜单页面 ${name} 失败`);
+    // 3.点击菜单页面
+    pageButton.click();
+};
+/**
+ * 调整游戏时间
+ * @param period 时间段
+ * @param config 时钟参数
+ */
+export const setTime = async (period, config) => {
+    // 1.打开时间页面
+    await openMenu("时间", true);
+    // 2.拨动指针
+    const { centerX = 1440, centerY = 502, radius = 400, offset = 5 } = config || {};
+    const index = ["night", "morning", "noon", "evening"].indexOf(period);
+    const periodsDirections = [
+        () => mouseSlide(centerX, centerY, centerX - offset, centerY + radius),
+        () => mouseSlide(centerX, centerY, centerX - radius, centerY - offset),
+        () => mouseSlide(centerX, centerY, centerX + offset, centerY - radius),
+        () => mouseSlide(centerX, centerY, centerX + radius, centerY + offset)
+    ];
+    const jobs = Array.from({ length: 4 }, (_, i) => periodsDirections[(index + i + 1) % periodsDirections.length]);
+    for (const job of jobs)
+        await job();
+    // 3.点击确认按钮，等待调整结束
+    const findTooShort = () => findTextInDirection("时间少于", true, true, "south-east");
+    const findConfirmButton = () => findTextInDirection("确认", false, true, "south-east");
+    const ok = await waitUntil(() => findTooShort() !== undefined, 20 * 1000, 1000, () => {
+        findConfirmButton()?.click();
+    });
+    if (!ok)
+        throw new Error("调整时间超时");
+    // 4.返回主界面
+    await genshin.returnMainUi();
+};

package/dist/http.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 发送 HTTP 请求，获取响应体内容
+ * @param method 请求方法
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export declare const requestForBody: (method: Parameters<typeof http.request>[0], url: string, body?: string, headers?: Record<string, any>) => Promise<string>;
+/**
+ * 发送 HTTP GET 请求，获取响应体内容
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export declare const getForBody: (url: string, body?: string, headers?: Record<string, any>) => Promise<string>;
+/**
+ * 发送 HTTP POST 请求，获取响应体内容
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export declare const postForBody: (url: string, body?: string, headers?: Record<string, any>) => Promise<{
+    status_code: number;
+    headers: Record<string, string>;
+    body: string;
+}>;

package/dist/http.js

@@ -0,0 +1,37 @@
+/**
+ * 发送 HTTP 请求，获取响应体内容
+ * @param method 请求方法
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export const requestForBody = async (method, url, body, headers) => {
+    const resp = await http.request(method, url, body ?? "null", headers ? JSON.stringify(headers) : "null");
+    if (resp.status_code >= 200 && resp.status_code < 400) {
+        return resp.body;
+    }
+    else {
+        throw new Error(`HTTP request failed with status ${resp.status_code}`);
+    }
+};
+/**
+ * 发送 HTTP GET 请求，获取响应体内容
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export const getForBody = async (url, body, headers) => {
+    return requestForBody("GET", url, body, headers);
+};
+/**
+ * 发送 HTTP POST 请求，获取响应体内容
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export const postForBody = (url, body, headers) => {
+    return http.request("POST", url, body, headers ? JSON.stringify(headers) : undefined);
+};

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-export * from "./action";
+export * from "./flow";
+export * from "./game";
+export * from "./http";
 export * from "./mouse";
 export * from "./ocr";
 export * from "./store";

package/dist/index.js

@@ -1,4 +1,6 @@
-export * from "./action";
+export * from "./flow";
+export * from "./game";
+export * from "./http";
 export * from "./mouse";
 export * from "./ocr";
 export * from "./store";

package/dist/ocr.d.ts

@@ -53,4 +53,22 @@ export declare const findTextWithinBounds: (text: string, contains: boolean, ign
  * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
  */
 export declare const findTextInDirection: (text: string, contains: boolean, ignoreCase: boolean, direction: Direction) => Region | undefined;
+/**
+ * 在列表视图中滚动搜索文本
+ * @param text 待搜索文本
+ * @param contains 是否包含
+ * @param ignoreCase 是否忽略大小写
+ * @param listView 列表视图参数
+ * @param timeout 搜索超时
+ * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
+ */
+export declare const findTextWithinListView: (text: string, contains: boolean, ignoreCase: boolean, listView: {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    maxListItems: number;
+    lineHeight: number;
+    padding?: number;
+}, timeout?: number) => Promise<Region | undefined>;
 export {};

package/dist/ocr.js

@@ -1,3 +1,5 @@
+import { waitUntil } from "./flow";
+import { mouseScrollDownLines } from "./mouse";
 const findFirst = (ir, ro, predicate) => {
     const candidates = ir.findMulti(ro);
     for (let i = 0; i < candidates.count; i++) {
@@ -108,3 +110,40 @@ export const findTextInDirection = (text, contains, ignoreCase, direction) => {
     const { x, y, w, h } = directionToBounds(direction);
     return findTextWithinBounds(text, contains, ignoreCase, x, y, w, h);
 };
+/**
+ * 在列表视图中滚动搜索文本
+ * @param text 待搜索文本
+ * @param contains 是否包含
+ * @param ignoreCase 是否忽略大小写
+ * @param listView 列表视图参数
+ * @param timeout 搜索超时
+ * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
+ */
+export const findTextWithinListView = async (text, contains, ignoreCase, listView, timeout) => {
+    const { x, y, w, h, maxListItems, lineHeight, padding = 10 } = listView;
+    const find = () => {
+        return findTextWithinBounds(text, contains, ignoreCase, x, y, w, h);
+    };
+    let firstRegion;
+    const isBottomTouched = () => {
+        const ro = RecognitionObject.ocr(x, y, w, h);
+        const list = captureGameRegion().findMulti(ro);
+        if (list.count > 0) {
+            if (firstRegion?.text === list[0].text && Math.abs(list[0].y - firstRegion.y) < lineHeight) {
+                return true;
+            }
+            else {
+                firstRegion = list[0];
+                return false;
+            }
+        }
+        else {
+            return true;
+        }
+    };
+    const ok = await waitUntil(() => find() != undefined || isBottomTouched(), timeout ?? 30 * 1000, 1000, async () => {
+        moveMouseTo(x + w - padding, y + padding);
+        await mouseScrollDownLines(maxListItems, lineHeight);
+    });
+    return ok ? find() : undefined;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bettergi/utils",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Utils for BetterGI JavaScript Development",
   "type": "module",
   "author": "Bread Grocery<https://github.com/breadgrocery>",
@@ -33,7 +33,7 @@
     "build": "tsc"
   },
   "devDependencies": {
-    "@bettergi/types": "^0.0.5",
-    "typescript": "^5.6.3"
+    "@bettergi/types": "^0.0.11",
+    "typescript": "5.6.3"
   }
 }