@bettergi/utils 0.0.8 → 0.0.10

package/README.md

@@ -1,11 +1,19 @@
-本项目是一个为[Better Genshin Impact](https://github.com/babalae/better-genshin-impact) 设计的 JavaScript 开发工具函数，旨在帮助开发者简化代码。
+本项目是一个为[Better Genshin Impact](https://github.com/babalae/better-genshin-impact) 设计的 JavaScript 开发工具集，旨在帮助开发者简化代码、不用重复造轮子。工具函数支持按需引入，轻量依赖。
 
 ## 安装
 
+### 使用 npm
+
 ```shell
 npm install @bettergi/utils
 ```
 
+### 使用 pnpm
+
+```shell
+pnpm install @bettergi/utils
+```
+
 ## 函数清单
 
 ### 游戏内操作

package/dist/flow.d.ts

@@ -7,4 +7,4 @@
  * @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>;
+export declare const waitUntil: (condition: (context: Record<string, any>) => boolean, timeout?: number, interval?: number, action?: (context: Record<string, any>) => Promise<void> | void) => Promise<boolean>;

package/dist/flow.js

@@ -7,14 +7,14 @@
  * @returns - true  在超时前条件已满足
  *          - false 在超时后条件仍未满足
  */
-export const waitUntil = async (condition, timeout, interval, action) => {
+export const waitUntil = async (condition, timeout = 3000, interval = 300, action) => {
     const context = {};
-    const deadline = Date.now() + (timeout ?? 3 * 1000);
+    const deadline = Date.now() + timeout;
     while (Date.now() < deadline) {
         if (condition(context))
             return true;
-        action?.(context);
-        await sleep(interval ?? 300);
+        await action?.(context);
+        await sleep(interval);
     }
     return false;
 };

package/dist/game.d.ts

@@ -1,4 +1,3 @@
-import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
 /**
  * 打开派蒙菜单
  */

package/dist/game.js

@@ -1,4 +1,3 @@
-import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
 import { waitUntil } from "./flow";
 import { mouseSlide } from "./mouse";
 import { findTextInDirection, findTextWithinBounds, findTextWithinListView } from "./ocr";
@@ -20,11 +19,11 @@ export const openPaimonMenu = async () => {
  * @param reverse 是否反向搜索（可选）
  * @param config 搜索参数（可选）
  */
-export const openMenu = async (name, reverse, config) => {
+export const openMenu = async (name, reverse = false, config = {}) => {
     // 1.打开派蒙菜单
     await openPaimonMenu();
     // 2.搜索菜单按钮
-    const { x = 50, step = 30, timeout = 3000 } = config || {};
+    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);
@@ -53,11 +52,11 @@ export const openMenu = async (name, reverse, config) => {
  * @param name 菜单页面名称
  * @param config 菜单页面视图参数
  */
-export const openMenuPage = async (name, config) => {
+export const openMenuPage = async (name, config = {}) => {
     // 1.打开派蒙菜单
     await openPaimonMenu();
     // 2.搜索菜单页面
-    const { x = 100, y = 330, w = 670, h = 730, lineHeight = 142 } = config || {};
+    const { x = 100, y = 330, w = 670, h = 730, lineHeight = 142 } = config;
     const pageButton = await findTextWithinListView(name, false, true, {
         x,
         y,
@@ -76,11 +75,11 @@ export const openMenuPage = async (name, config) => {
  * @param period 时间段
  * @param config 时钟参数
  */
-export const setTime = async (period, config) => {
+export const setTime = async (period, config = {}) => {
     // 1.打开时间页面
     await openMenu("时间", true);
     // 2.拨动指针
-    const { centerX = 1440, centerY = 502, radius = 400, offset = 5 } = config || {};
+    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),

package/dist/http.js

@@ -6,8 +6,8 @@
  * @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");
+export const requestForBody = async (method, url, body = "null", headers) => {
+    const resp = await http.request(method, url, body, headers ? JSON.stringify(headers) : "null");
     if (resp.status_code >= 200 && resp.status_code < 400) {
         return resp.body;
     }

package/dist/mouse.js

@@ -10,36 +10,32 @@ const _simulateScroll = async (scrollAmountInClicks, times) => {
  * @param height 滚动高度
  * @param algorithm 自定义滚动算法函数，接收高度参数并返回滚动次数（默认算法为每18像素滚动一次）
  */
-export const mouseScrollUp = (height, algorithm) => {
-    const scrollAlgorithm = algorithm ?? (h => Math.floor(h / 18));
-    const scrollTimes = scrollAlgorithm(height);
-    return _simulateScroll(120, scrollTimes);
+export const mouseScrollUp = (height, algorithm = h => Math.floor(h / 18)) => {
+    return _simulateScroll(120, algorithm(height));
 };
 /**
  * 鼠标滚轮向下滚动指定高度
  * @param height 滚动高度
  * @param algorithm 自定义滚动算法函数，接收高度参数并返回滚动次数（默认算法为每18像素滚动一次）
  */
-export const mouseScrollDown = (height, algorithm) => {
-    const scrollAlgorithm = algorithm ?? (h => Math.floor(h / 18));
-    const scrollTimes = scrollAlgorithm(height);
-    return _simulateScroll(-120, scrollTimes);
+export const mouseScrollDown = (height, algorithm = h => Math.floor(h / 18)) => {
+    return _simulateScroll(-120, algorithm(height));
 };
 /**
  * 鼠标滚轮向上滚动指定行数
  * @param lines 滚动行数
  * @param lineHeight 行高（默认值为175像素）
  */
-export const mouseScrollUpLines = (lines, lineHeight) => {
-    return mouseScrollUp(lines * (lineHeight ?? 175));
+export const mouseScrollUpLines = (lines, lineHeight = 175) => {
+    return mouseScrollUp(lines * lineHeight);
 };
 /**
  * 鼠标滚轮向下滚动指定行数
  * @param lines 滚动行数
  * @param lineHeight 行高（默认值为175像素）
  */
-export const mouseScrollDownLines = (lines, lineHeight) => {
-    return mouseScrollDown(lines * (lineHeight ?? 175));
+export const mouseScrollDownLines = (lines, lineHeight = 175) => {
+    return mouseScrollDown(lines * lineHeight);
 };
 /**
  * 鼠标拖拽滑动到指定位置

package/dist/ocr.d.ts

@@ -1,5 +1,3 @@
-import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/ImageRegion";
-import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
 type Direction = "north" | "north-east" | "east" | "south-east" | "south" | "south-west" | "west" | "north-west";
 /**
  * 在整个画面内搜索图片

package/dist/ocr.js

@@ -1,5 +1,3 @@
-import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/ImageRegion";
-import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
 import { waitUntil } from "./flow";
 import { mouseScrollDownLines } from "./mouse";
 const findFirst = (ir, ro, predicate) => {
@@ -121,7 +119,7 @@ export const findTextInDirection = (text, contains, ignoreCase, direction) => {
  * @param timeout 搜索超时
  * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
  */
-export const findTextWithinListView = async (text, contains, ignoreCase, listView, timeout) => {
+export const findTextWithinListView = async (text, contains, ignoreCase, listView, timeout = 30 * 1000) => {
     const { x, y, w, h, maxListItems, lineHeight, padding = 10 } = listView;
     const find = () => {
         return findTextWithinBounds(text, contains, ignoreCase, x, y, w, h);
@@ -143,7 +141,7 @@ export const findTextWithinListView = async (text, contains, ignoreCase, listVie
             return true;
         }
     };
-    const ok = await waitUntil(() => find() != undefined || isBottomTouched(), timeout ?? 30 * 1000, 1000, async () => {
+    const ok = await waitUntil(() => find() != undefined || isBottomTouched(), timeout, 1000, async () => {
         moveMouseTo(x + w - padding, y + padding);
         await mouseScrollDownLines(maxListItems, lineHeight);
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bettergi/utils",
-  "version": "0.0.8",
-  "description": "Utils for BetterGI JavaScript Development",
+  "version": "0.0.10",
+  "description": "开发 BetterGI 脚本常用工具集",
   "type": "module",
   "author": "Bread Grocery<https://github.com/breadgrocery>",
   "license": "MIT",
@@ -33,7 +33,7 @@
     "build": "tsc"
   },
   "devDependencies": {
-    "@bettergi/types": "^0.0.12",
+    "@bettergi/types": "^0.0.13",
     "typescript": "5.6.3"
   }
 }

package/dist/action.d.ts

@@ -1,10 +0,0 @@
-/**
- * 等待直到条件满足或超时
- * @param condition 等待的条件判断函数，返回 true 表示条件满足
- * @param timeout 超时时间（毫秒），默认 5000 毫秒
- * @param interval 等待间隔（毫秒），默认 200 毫秒
- * @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/action.js

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