@bettergi/utils 0.0.1

package/README.md

@@ -0,0 +1,21 @@
+Utils for [Better Genshin Impact](https://github.com/babalae/better-genshin-impact) JavaScript development.
+
+## Installation
+
+```shell
+npm install @bettergi/utils
+```
+
+## Example
+
+```ts
+import { findImage } from "@bettergi/utils";
+
+const mailIcon = findImage("./assets/mail.png");
+
+mailIcon?.click();
+```
+
+## Related Tools
+
+[@bettergi/create-script](https://www.npmjs.com/package/@bettergi/create-script)

package/dist/action.d.ts

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

package/dist/action.js

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

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./action";
+export * from "./mouse";
+export * from "./ocr";

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "./action";
+export * from "./mouse";
+export * from "./ocr";

package/dist/mouse.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 鼠标滚轮向上滚动指定高度
+ * @param height 滚动高度
+ * @param algorithm 自定义滚动算法函数，接收高度参数并返回滚动次数（默认算法为每18像素滚动一次）
+ */
+export declare const mouseScrollUp: (height: number, algorithm?: (h: number) => number) => Promise<void>;
+/**
+ * 鼠标滚轮向下滚动指定高度
+ * @param height 滚动高度
+ * @param algorithm 自定义滚动算法函数，接收高度参数并返回滚动次数（默认算法为每18像素滚动一次）
+ */
+export declare const mouseScrollDown: (height: number, algorithm?: (height: number) => number) => Promise<void>;
+/**
+ * 鼠标滚轮向上滚动指定行数
+ * @param lines 滚动行数
+ * @param lineHeight 行高（默认值为175像素）
+ */
+export declare const mouseScrollUpLines: (lines: number, lineHeight?: number) => Promise<void>;
+/**
+ * 鼠标滚轮向下滚动指定行数
+ * @param lines 滚动行数
+ * @param lineHeight 行高（默认值为175像素）
+ */
+export declare const mouseScrollDownLines: (lines: number, lineHeight?: number) => Promise<void>;

package/dist/mouse.js

@@ -0,0 +1,43 @@
+const _simulateScroll = async (scrollAmountInClicks, times) => {
+    const script = {
+        macroEvents: Array(times).fill({ type: 6, mouseX: 0, mouseY: scrollAmountInClicks, time: 0 }),
+        info: { name: "", description: "", x: 0, y: 0, width: 1920, height: 1080, recordDpi: 1.25 }
+    };
+    await keyMouseScript.run(JSON.stringify(script));
+};
+/**
+ * 鼠标滚轮向上滚动指定高度
+ * @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);
+};
+/**
+ * 鼠标滚轮向下滚动指定高度
+ * @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);
+};
+/**
+ * 鼠标滚轮向上滚动指定行数
+ * @param lines 滚动行数
+ * @param lineHeight 行高（默认值为175像素）
+ */
+export const mouseScrollUpLines = (lines, lineHeight) => {
+    return mouseScrollUp(lines * (lineHeight ?? 175));
+};
+/**
+ * 鼠标滚轮向下滚动指定行数
+ * @param lines 滚动行数
+ * @param lineHeight 行高（默认值为175像素）
+ */
+export const mouseScrollDownLines = (lines, lineHeight) => {
+    return mouseScrollDown(lines * (lineHeight ?? 175));
+};

package/dist/ocr.d.ts

@@ -0,0 +1,38 @@
+import { type Region } from "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
+/**
+ * 搜索图片
+ * @param path 图片路径
+ * @returns 如果找到匹配的图片区域，则返回该区域，否则返回 undefined
+ */
+export declare const findImage: (path: string) => Region | undefined;
+/**
+ * 在指定区域内搜索图片
+ * @param path 图片路径
+ * @param x - 水平移动偏移量（像素）
+ * @param y - 垂直移动偏移量（像素）
+ * @param w 宽度
+ * @param h 高度
+ * @returns 如果找到匹配的图片区域，则返回该区域，否则返回 undefined
+ */
+export declare const findImageWithinBounds: (path: string, x: number, y: number, w: number, h: number) => Region | undefined;
+/**
+ * 搜索文本
+ * @param text 待搜索文本
+ * @param contains 是否包含
+ * @param ignoreCase 是否忽略大小写
+ * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
+ */
+export declare const findText: (text: string, contains: boolean, ignoreCase: boolean) => Region | undefined;
+/**
+ * 在指定区域内搜索文本
+ * @param text 待搜索文本
+ * @param contains 是否包含
+ * @param ignoreCase 是否忽略大小写
+ * @param x 水平移动偏移量（像素）
+ * @param x - 水平移动偏移量（像素）
+ * @param y - 垂直移动偏移量（像素）
+ * @param w 宽度
+ * @param h 高度
+ * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
+ */
+export declare const findTextWithinBounds: (text: string, contains: boolean, ignoreCase: boolean, x: number, y: number, w: number, h: number) => Region | undefined;

package/dist/ocr.js

@@ -0,0 +1,82 @@
+const findFirst = (im, ro, predicate) => {
+    const candidates = im.findMulti(ro);
+    for (let i = 0; i < candidates.count; i++) {
+        if (predicate(candidates[i])) {
+            return candidates[i];
+        }
+    }
+    return undefined;
+};
+/**
+ * 搜索图片
+ * @param path 图片路径
+ * @returns 如果找到匹配的图片区域，则返回该区域，否则返回 undefined
+ */
+export const findImage = (path) => {
+    try {
+        const im = captureGameRegion();
+        const ro = RecognitionObject.templateMatch(file.readImageMatSync(path));
+        return findFirst(im, ro, region => region.isExist());
+    }
+    catch (err) {
+        err?.message && log.warn(`${err.message}`);
+    }
+};
+/**
+ * 在指定区域内搜索图片
+ * @param path 图片路径
+ * @param x - 水平移动偏移量（像素）
+ * @param y - 垂直移动偏移量（像素）
+ * @param w 宽度
+ * @param h 高度
+ * @returns 如果找到匹配的图片区域，则返回该区域，否则返回 undefined
+ */
+export const findImageWithinBounds = (path, x, y, w, h) => {
+    try {
+        const im = captureGameRegion();
+        const ro = RecognitionObject.templateMatch(file.readImageMatSync(path), x, y, w, h);
+        return findFirst(im, ro, region => region.isExist());
+    }
+    catch (err) {
+        err?.message && log.warn(`${err.message}`);
+    }
+};
+/**
+ * 搜索文本
+ * @param text 待搜索文本
+ * @param contains 是否包含
+ * @param ignoreCase 是否忽略大小写
+ * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
+ */
+export const findText = (text, contains, ignoreCase) => {
+    const searchText = ignoreCase ? text.toLowerCase() : text;
+    const im = captureGameRegion();
+    const ro = RecognitionObject.ocrThis;
+    return findFirst(im, ro, region => {
+        const itemText = ignoreCase ? region.text.toLowerCase() : region.text;
+        const isMatch = contains ? itemText.includes(searchText) : itemText === searchText;
+        return isMatch && region.isExist();
+    });
+};
+/**
+ * 在指定区域内搜索文本
+ * @param text 待搜索文本
+ * @param contains 是否包含
+ * @param ignoreCase 是否忽略大小写
+ * @param x 水平移动偏移量（像素）
+ * @param x - 水平移动偏移量（像素）
+ * @param y - 垂直移动偏移量（像素）
+ * @param w 宽度
+ * @param h 高度
+ * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
+ */
+export const findTextWithinBounds = (text, contains, ignoreCase, x, y, w, h) => {
+    const searchText = ignoreCase ? text.toLowerCase() : text;
+    const im = captureGameRegion();
+    const ro = RecognitionObject.ocr(x, y, w, h);
+    return findFirst(im, ro, region => {
+        const itemText = ignoreCase ? region.text.toLowerCase() : region.text;
+        const isMatch = contains ? itemText.includes(searchText) : itemText === searchText;
+        return isMatch && region.isExist();
+    });
+};

package/dist/polyfill.d.ts

@@ -0,0 +1 @@
+export declare const verticalScroll: (scrollAmountInClicks: number) => void;

package/dist/polyfill.js

@@ -0,0 +1,10 @@
+import { _simulateScroll } from "./mouse";
+export const verticalScroll = (scrollAmountInClicks) => {
+    // @ts-ignore
+    if (globalThis.verticalScroll) {
+        globalThis.verticalScroll(scrollAmountInClicks);
+    }
+    else {
+        _simulateScroll(scrollAmountInClicks, 1);
+    }
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@bettergi/utils",
+  "version": "0.0.1",
+  "description": "Utils for BetterGI JavaScript Development",
+  "type": "module",
+  "author": "Bread Grocery<https://github.com/breadgrocery>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/breadgrocery/bettergi-script-toolchain.git",
+    "directory": "packages/utils"
+  },
+  "bugs": {
+    "url": "https://github.com/breadgrocery/bettergi-script-toolchain/issues"
+  },
+  "homepage": "https://github.com/breadgrocery/bettergi-script-toolchain/tree/main/packages/utils",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "bettergi",
+    "utils"
+  ],
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "@bettergi/types": "^0.0.5",
+    "typescript": "^5.6.3"
+  }
+}