@bettergi/utils 0.1.11 → 0.1.12

package/README.md

@@ -50,20 +50,26 @@ await navigateToTab(() => {
 // 在整个画面内搜索图片，找不到返回 undefined
 const i1 = findImage("assets/关闭.png", { use3Channels: true }); // 匹配颜色
 
-// 在指定方向上搜索图片，找不到返回 undefined
-const i2 = findImageInDirection("assets/关闭.png", "north-east");
-
 // 在指定区域内搜索图片，找不到返回 undefined
-const i3 = findImageWithinBounds("assets/关闭.png", 960, 0, 960, 1080);
+const i2 = findImageWithinBounds("assets/关闭.png", 960, 0, 960, 1080);
+
+// 在指定坐标范围内搜索图片，找不到返回 undefined
+const i3 = findImageBetweenCoordinates("assets/关闭.png", 960, 0, 1920, 1080);
+
+// 在指定方向上搜索图片，找不到返回 undefined
+const i4 = findImageInDirection("assets/关闭.png", "north-east");
 
 // 在整个画面内搜索文本（不包含、忽略大小写），找不到返回 undefined
 const t1 = findText("购买");
 
-// 在指定方向上搜索文本（包含、忽略大小写），找不到返回 undefined
-const t2 = findTextInDirection("师傅", "east", { contains: true, ignoreCase: true });
-
 // 在指定区域内搜索文本（不包含、忽略大小写），找不到返回 undefined
-const t3 = findTextWithinBounds("确认", 960, 540, 960, 540);
+const t2 = findTextWithinBounds("确认", 960, 540, 960, 540);
+
+// 在指定坐标范围内搜索文本（不包含、忽略大小写），找不到返回 undefined
+const t3 = findTextBetweenCoordinates("确认", 960, 540, 1920, 1080);
+
+// 在指定方向上搜索文本（包含、忽略大小写），找不到返回 undefined
+const t4 = findTextInDirection("师傅", "east", { contains: true, ignoreCase: true });
 ```
 
 ### 行为流程
@@ -119,7 +125,7 @@ await mouseScrollUpLines(99);
 await mouseScrollDownLines(1, 115);
 ```
 
-### 数据存储
+### 状态管理和持久化
 
 > 对象数据持久化，通过 Proxy 实现自动存储。从而可以无感知地读取/更新数据，而无需考虑如何持久化。
 

package/dist/mouse.d.ts

@@ -1,6 +1,8 @@
 export type MouseWaypointsOptions = {
     /** 是否按住鼠标左键拖动 */
     shouldDrag?: boolean;
+    /** 移动延时（毫秒） */
+    delay?: number;
     /** 超时时间（毫秒，默认: 不超时） */
     timeout?: number;
 };

package/dist/mouse.js

@@ -4,7 +4,7 @@
  * @param options 鼠标移动选项
  */
 export const mouseMoveAlongWaypoints = async (waypoints, options) => {
-    const { shouldDrag = false, timeout = 0 } = options || {};
+    const { shouldDrag = false, delay = 50, timeout = 0 } = options || {};
     try {
         const startTime = Date.now();
         for (let i = 0; i < waypoints.length; i++) {
@@ -13,9 +13,9 @@ export const mouseMoveAlongWaypoints = async (waypoints, options) => {
                 leftButtonDown();
             moveMouseTo(Math.trunc(waypoints[i].x), Math.trunc(waypoints[i].y));
             // 等待指定延迟
-            const delay = Math.trunc(waypoints[i].delay || 50);
-            if (delay > 0)
-                await sleep(delay);
+            const duration = Math.trunc(waypoints[i].delay || delay);
+            if (duration > 0)
+                await sleep(duration);
             // 超时检查
             if (timeout > 0 && Date.now() - startTime > timeout)
                 return false;

package/dist/ocr.d.ts

@@ -1,7 +1,9 @@
 import { RetryOptions } from "./workflow";
+/** 识别对象实例 */
 export type ROInstance = InstanceType<typeof RecognitionObject>;
+/** 识别对象配置 */
 export type ROConfig = Partial<{
-    [K in keyof ROInstance]: ROInstance[K];
+    [K in keyof ROInstance as ROInstance[K] extends Function ? never : K]: ROInstance[K];
 }>;
 export type MatchDirection = "north" /** 上半边 */ | "north-east" /** 右上四分之一 */ | "east" /** 右半边 */ | "south-east" /** 右下四分之一 */ | "south" /** 下半边 */ | "south-west" /** 左下四分之一 */ | "west" /** 左半边 */ | "north-west"; /** 左上四分之一 */
 /**
@@ -22,6 +24,17 @@ export declare const findImage: (path: string, config?: ROConfig) => Region | un
  * @returns 如果找到匹配的图片区域，则返回该区域
  */
 export declare const findImageWithinBounds: (path: string, x: number, y: number, w: number, h: number, config?: ROConfig) => Region | undefined;
+/**
+ * 在指定坐标范围内搜索图片
+ * @param path 图片路径
+ * @param left 左边界偏移量（像素）
+ * @param top 上边界偏移量（像素）
+ * @param right 右边界偏移量（像素）
+ * @param bottom 下边界偏移量（像素）
+ * @param config 识别对象配置
+ * @returns 如果找到匹配的图片区域，则返回该区域
+ */
+export declare const findImageBetweenCoordinates: (path: string, left: number, top: number, right: number, bottom: number, config?: ROConfig) => Region | undefined;
 /**
  * 在指定方向上搜索图片
  * @param path 图片路径
@@ -57,6 +70,18 @@ export declare const findText: (text: string, options?: TextMatchOptions, config
  * @returns 如果找到匹配的文本区域，则返回该区域
  */
 export declare const findTextWithinBounds: (text: string, x: number, y: number, w: number, h: number, options?: TextMatchOptions, config?: ROConfig) => Region | undefined;
+/**
+ * 在指定坐标范围内搜索文本
+ * @param text 待搜索文本
+ * @param left 左边界偏移量（像素）
+ * @param top 上边界偏移量（像素）
+ * @param right 右边界偏移量（像素）
+ * @param bottom 下边界偏移量（像素）
+ * @param options 搜索选项
+ * @param config 识别对象配置
+ * @returns 如果找到匹配的文本区域，则返回该区域
+ */
+export declare const findTextBetweenCoordinates: (text: string, left: number, top: number, right: number, bottom: number, options?: TextMatchOptions, config?: ROConfig) => Region | undefined;
 /**
  * 在指定方向上搜索文本
  * @param text 待搜索文本

package/dist/ocr.js

@@ -65,6 +65,19 @@ export const findImageWithinBounds = (path, x, y, w, h, config = {}) => {
         ir.dispose();
     }
 };
+/**
+ * 在指定坐标范围内搜索图片
+ * @param path 图片路径
+ * @param left 左边界偏移量（像素）
+ * @param top 上边界偏移量（像素）
+ * @param right 右边界偏移量（像素）
+ * @param bottom 下边界偏移量（像素）
+ * @param config 识别对象配置
+ * @returns 如果找到匹配的图片区域，则返回该区域
+ */
+export const findImageBetweenCoordinates = (path, left, top, right, bottom, config = {}) => {
+    return findImageWithinBounds(path, left, top, right - left, bottom - top, config);
+};
 /**
  * 在指定方向上搜索图片
  * @param path 图片路径
@@ -134,6 +147,20 @@ export const findTextWithinBounds = (text, x, y, w, h, options, config = {}) =>
         ir.dispose();
     }
 };
+/**
+ * 在指定坐标范围内搜索文本
+ * @param text 待搜索文本
+ * @param left 左边界偏移量（像素）
+ * @param top 上边界偏移量（像素）
+ * @param right 右边界偏移量（像素）
+ * @param bottom 下边界偏移量（像素）
+ * @param options 搜索选项
+ * @param config 识别对象配置
+ * @returns 如果找到匹配的文本区域，则返回该区域
+ */
+export const findTextBetweenCoordinates = (text, left, top, right, bottom, options, config = {}) => {
+    return findTextWithinBounds(text, left, top, right - left, bottom - top, options, config);
+};
 /**
  * 在指定方向上搜索文本
  * @param text 待搜索文本
@@ -179,6 +206,7 @@ export const findTextWithinListView = async (text, listView, matchOptions, retry
     };
     const isTextFoundOrBottomReached = await waitForAction(() => findTargetText() != undefined || isReachedBottom(), async () => {
         moveMouseTo(x + w - paddingX, y + paddingY); // 移动到滚动条附近
+        await sleep(50);
         await mouseScrollDownLines(scrollLines, lineHeight); // 滚动指定行数
     }, { maxAttempts, retryInterval });
     return isTextFoundOrBottomReached ? findTargetText() : undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bettergi/utils",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "description": "开发 BetterGI 脚本常用工具集",
   "type": "module",
   "author": "Bread Grocery<https://github.com/breadgrocery>",