@bettergi/utils 0.0.11 → 0.1.1

package/dist/workflow.js

@@ -0,0 +1,74 @@
+/** 默认最大重试次数 */
+const defaultMaxAttempts = 5;
+/** 默认重试间隔（毫秒） */
+const defaultRetryInterval = 1000;
+/**
+ * 等待直到条件满足或超时，期间执行重试操作
+ * @param condition 返回条件是否满足的函数
+ * @param retryAction 每次重试时执行的操作（可选）
+ * @param options 配置选项
+ * @returns - true  条件满足
+ *          - false 达到最大重试次数
+ */
+export const waitForAction = async (condition, retryAction, options) => {
+    const { maxAttempts = defaultMaxAttempts, retryInterval = defaultRetryInterval } = options || {};
+    for (let i = 0; i < maxAttempts; i++) {
+        if (i === 0 && condition())
+            return true; // fast path
+        await retryAction?.();
+        await sleep(retryInterval);
+        if (condition())
+            return true;
+    }
+    return false;
+};
+/**
+ * 等待某个区域出现，期间执行重试操作
+ * @param regionProvider 返回区域的函数
+ * @param retryAction 每次重试时执行的操作（可选）
+ * @param options 配置选项
+ * @returns - true  区域出现
+ *          - false 达到最大重试次数
+ */
+export const waitForRegionAppear = async (regionProvider, retryAction, options) => {
+    return waitForAction(() => {
+        const region = regionProvider();
+        return region != null && region.isExist();
+    }, retryAction, options);
+};
+/**
+ * 等待某个区域消失，期间执行重试操作
+ * @param regionProvider 返回区域的函数
+ * @param retryAction 每次重试时执行的操作（可选）
+ * @param options 配置选项
+ * @returns - true  区域消失
+ *          - false 达到最大重试次数
+ */
+export const waitForRegionDisappear = async (regionProvider, retryAction, options) => {
+    return waitForAction(() => {
+        const region = regionProvider();
+        return !region || !region.isExist();
+    }, retryAction, options);
+};
+/**
+ * 等待整个画面上某个元素出现，期间执行重试操作
+ * @param recognitionObject 识别对象
+ * @param retryAction 每次重试时执行的操作（可选）
+ * @param options 配置选项
+ * @returns - true  整个画面上某个元素出现
+ *          - false 达到最大重试次数
+ */
+export const waitForElementAppear = async (recognitionObject, retryAction, options) => {
+    return waitForRegionAppear(() => captureGameRegion().find(recognitionObject), retryAction, options);
+};
+/**
+ * 等待整个画面上某个元素消失，期间执行重试操作
+ * @param recognitionObject 识别对象
+ * @param retryAction 每次重试时执行的操作（可选）
+ * @param options 配置选项
+ * @returns - true  整个画面上某个元素消失
+ *          - false 达到最大重试次数
+ */
+export const waitForElementDisappear = async (recognitionObject, retryAction, options) => {
+    return waitForRegionDisappear(() => captureGameRegion().find(recognitionObject), retryAction, options);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bettergi/utils",
-  "version": "0.0.11",
+  "version": "0.1.1",
   "description": "开发 BetterGI 脚本常用工具集",
   "type": "module",
   "author": "Bread Grocery<https://github.com/breadgrocery>",
@@ -33,7 +33,7 @@
     "build": "tsc"
   },
   "devDependencies": {
-    "@bettergi/types": "^0.0.14",
+    "@bettergi/types": "^0.1.1",
     "typescript": "^5.9.3"
   }
 }

package/dist/flow.d.ts

@@ -1,30 +0,0 @@
-/**
- * 等待直到条件满足或超时
- * @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>) => Promise<void> | void) => Promise<boolean>;
-/**
- * 断言区域存在
- * @param 获取区域的函数
- * @param message 错误信息
- * @param timeout 超时时间（毫秒），默认 3000 毫秒
- * @param interval 等待间隔（毫秒），默认 300 毫秒
- * @param action 每次等待循环中执行的操作（可选）
- * @throws 如果区域在超时时间内未找到则抛出错误
- */
-export declare const assertExists: (regionProvider: () => Region | undefined, message?: string, timeout?: number, interval?: number, action?: (context: Record<string, any>) => Promise<void> | void) => Promise<void>;
-/**
- * 断言区域不存在
- * @param 获取区域的函数
- * @param message 错误信息
- * @param timeout 超时时间（毫秒），默认 3000 毫秒
- * @param interval 等待间隔（毫秒），默认 300 毫秒
- * @param action 每次等待循环中执行的操作（可选）
- * @throws 如果区域在超时时间内仍然存在则抛出错误
- */
-export declare const assertNotExists: (regionProvider: () => Region | undefined, message?: string, timeout?: number, interval?: number, action?: (context: Record<string, any>) => Promise<void> | void) => Promise<void>;

package/dist/flow.js

@@ -1,52 +0,0 @@
-/** 默认超时时间（毫秒） */
-const defaultTimeout = 3 * 1000;
-/** 默认等待间隔（毫秒） */
-const defaultInterval = 300;
-/**
- * 等待直到条件满足或超时
- * @param condition 等待的条件判断函数，返回 true 表示条件满足
- * @param timeout 超时时间（毫秒），默认 3000 毫秒
- * @param interval 等待间隔（毫秒），默认 300 毫秒
- * @param action 每次等待循环中执行的操作（可选）
- * @returns - true  在超时前条件已满足
- *          - false 在超时后条件仍未满足
- */
-export const waitUntil = async (condition, timeout = defaultTimeout, interval = defaultInterval, action) => {
-    const context = {};
-    const deadline = Date.now() + timeout;
-    while (Date.now() < deadline) {
-        if (condition(context))
-            return true;
-        await action?.(context);
-        await sleep(interval);
-    }
-    return false;
-};
-/**
- * 断言区域存在
- * @param 获取区域的函数
- * @param message 错误信息
- * @param timeout 超时时间（毫秒），默认 3000 毫秒
- * @param interval 等待间隔（毫秒），默认 300 毫秒
- * @param action 每次等待循环中执行的操作（可选）
- * @throws 如果区域在超时时间内未找到则抛出错误
- */
-export const assertExists = async (regionProvider, message = "断言区域存在失败", timeout = defaultTimeout, interval = defaultInterval, action) => {
-    const ok = await waitUntil(() => regionProvider() !== undefined, timeout, interval, action);
-    if (!ok)
-        throw new Error(message);
-};
-/**
- * 断言区域不存在
- * @param 获取区域的函数
- * @param message 错误信息
- * @param timeout 超时时间（毫秒），默认 3000 毫秒
- * @param interval 等待间隔（毫秒），默认 300 毫秒
- * @param action 每次等待循环中执行的操作（可选）
- * @throws 如果区域在超时时间内仍然存在则抛出错误
- */
-export const assertNotExists = async (regionProvider, message = "断言区域不存在失败", timeout = defaultTimeout, interval = defaultInterval, action) => {
-    const ok = await waitUntil(() => regionProvider() === undefined, timeout, interval, action);
-    if (!ok)
-        throw new Error(message);
-};