@bettergi/utils 0.1.13 → 0.1.15

package/README.md

@@ -154,21 +154,19 @@ const total = 100;
 const tracker = new ProgressTracker(total, { interval: 3000 });
 for (let i = 0; i < total; i++) {
   await sleep(Math.round(Math.random() * 200));
-  // 递进并尝试打印进度和消息
-  tracker.tick({ message: "等待任务完成..." });
-
-  // 也可以主动追踪，使用传递的进度信息自主控制打印时机和内容
-  // tracker.track((progress, shouldPrint, printed) => {
-  //   if (!shouldPrint()) return;
-  //   log.info(
-  //     "[进度: {pct} 预计剩余时间: {eta}]: 等待任务完成...",
-  //     progress.formatted.percentage,
-  //     progress.formatted.remaining
-  //   );
-  //   printed();
-  // });
+  // 仅递进+1
+  tracker.tick();
+  // 递进+3，并尝试打印当前进度和消息
+  tracker.tick({ message: "等待任务完成...", increment: 3 });
+  // 不递进，尝试打印当前进度和消息
+  tracker.print("等待任务完成...");
+  // 不递进，强制打印当前进度和警告消息
+  tracker.print("等待任务完成...", true, log.warn);
+  // 自定义模板
+  const progress = tracker.getProgress();
+  log.info("[{current}/{total}]: {msg}", progress.current, progress.total, "消息");
 }
-tracker.complete(`执行完成`);
+tracker.complete(`任务完成`);
 ```
 
 ### 网络请求

package/dist/ocr.d.ts

@@ -5,17 +5,18 @@ export type ROInstance = InstanceType<typeof RecognitionObject>;
 export type ROConfig = Partial<{
     [K in keyof ROInstance as ROInstance[K] extends Function ? never : K]: ROInstance[K];
 }>;
+export type ImageMat = ReturnType<typeof file.readImageMatSync>;
 export type MatchDirection = "north" /** 上半边 */ | "north-east" /** 右上四分之一 */ | "east" /** 右半边 */ | "south-east" /** 右下四分之一 */ | "south" /** 下半边 */ | "south-west" /** 左下四分之一 */ | "west" /** 左半边 */ | "north-west"; /** 左上四分之一 */
 /**
  * 在整个画面内搜索图片
- * @param path 图片路径
+ * @param image 图片路径 或 图片矩阵
  * @param config 识别对象配置
  * @returns 如果找到匹配的图片区域，则返回该区域
  */
-export declare const findImage: (path: string, config?: ROConfig) => Region | undefined;
+export declare const findImage: (image: string | ImageMat, config?: ROConfig) => Region | undefined;
 /**
  * 在指定区域内搜索图片
- * @param path 图片路径
+ * @param image 图片路径 或 图片矩阵
  * @param x 水平方向偏移量（像素）
  * @param y 垂直方向偏移量（像素）
  * @param w 宽度
@@ -23,10 +24,10 @@ export declare const findImage: (path: string, config?: ROConfig) => Region | un
  * @param config 识别对象配置
  * @returns 如果找到匹配的图片区域，则返回该区域
  */
-export declare const findImageWithinBounds: (path: string, x: number, y: number, w: number, h: number, config?: ROConfig) => Region | undefined;
+export declare const findImageWithinBounds: (image: string | ImageMat, x: number, y: number, w: number, h: number, config?: ROConfig) => Region | undefined;
 /**
  * 在指定坐标范围内搜索图片
- * @param path 图片路径
+ * @param image 图片路径 或 图片矩阵
  * @param left 左边界偏移量（像素）
  * @param top 上边界偏移量（像素）
  * @param right 右边界偏移量（像素）
@@ -34,15 +35,15 @@ export declare const findImageWithinBounds: (path: string, x: number, y: number,
  * @param config 识别对象配置
  * @returns 如果找到匹配的图片区域，则返回该区域
  */
-export declare const findImageBetweenCoordinates: (path: string, left: number, top: number, right: number, bottom: number, config?: ROConfig) => Region | undefined;
+export declare const findImageBetweenCoordinates: (image: string | ImageMat, left: number, top: number, right: number, bottom: number, config?: ROConfig) => Region | undefined;
 /**
  * 在指定方向上搜索图片
- * @param path 图片路径
+ * @param image 图片路径 或 图片矩阵
  * @param direction 搜索方向
  * @param config 识别对象配置
  * @returns 如果找到匹配的图片区域，则返回该区域
  */
-export declare const findImageInDirection: (path: string, direction: MatchDirection, config?: ROConfig) => Region | undefined;
+export declare const findImageInDirection: (image: string | ImageMat, direction: MatchDirection, config?: ROConfig) => Region | undefined;
 /** 文本搜索选项 */
 export type TextMatchOptions = {
     /** 是否忽略大小写（默认: 是） */

package/dist/ocr.js

@@ -23,14 +23,15 @@ const directionToBounds = (direction) => {
 };
 /**
  * 在整个画面内搜索图片
- * @param path 图片路径
+ * @param image 图片路径 或 图片矩阵
  * @param config 识别对象配置
  * @returns 如果找到匹配的图片区域，则返回该区域
  */
-export const findImage = (path, config = {}) => {
+export const findImage = (image, config = {}) => {
     const ir = captureGameRegion();
     try {
-        const ro = RecognitionObject.templateMatch(file.readImageMatSync(path));
+        const mat = typeof image === "string" ? file.readImageMatSync(image) : image;
+        const ro = RecognitionObject.templateMatch(mat);
         Object.assign(ro, config);
         return findFirst(ir, ro, region => region.isExist());
     }
@@ -43,7 +44,7 @@ export const findImage = (path, config = {}) => {
 };
 /**
  * 在指定区域内搜索图片
- * @param path 图片路径
+ * @param image 图片路径 或 图片矩阵
  * @param x 水平方向偏移量（像素）
  * @param y 垂直方向偏移量（像素）
  * @param w 宽度
@@ -51,10 +52,11 @@ export const findImage = (path, config = {}) => {
  * @param config 识别对象配置
  * @returns 如果找到匹配的图片区域，则返回该区域
  */
-export const findImageWithinBounds = (path, x, y, w, h, config = {}) => {
+export const findImageWithinBounds = (image, x, y, w, h, config = {}) => {
     const ir = captureGameRegion();
     try {
-        const ro = RecognitionObject.templateMatch(file.readImageMatSync(path), x, y, w, h);
+        const mat = typeof image === "string" ? file.readImageMatSync(image) : image;
+        const ro = RecognitionObject.templateMatch(mat, x, y, w, h);
         Object.assign(ro, config);
         return findFirst(ir, ro, region => region.isExist());
     }
@@ -67,7 +69,7 @@ export const findImageWithinBounds = (path, x, y, w, h, config = {}) => {
 };
 /**
  * 在指定坐标范围内搜索图片
- * @param path 图片路径
+ * @param image 图片路径 或 图片矩阵
  * @param left 左边界偏移量（像素）
  * @param top 上边界偏移量（像素）
  * @param right 右边界偏移量（像素）
@@ -75,19 +77,19 @@ export const findImageWithinBounds = (path, x, y, w, h, config = {}) => {
  * @param config 识别对象配置
  * @returns 如果找到匹配的图片区域，则返回该区域
  */
-export const findImageBetweenCoordinates = (path, left, top, right, bottom, config = {}) => {
-    return findImageWithinBounds(path, left, top, right - left, bottom - top, config);
+export const findImageBetweenCoordinates = (image, left, top, right, bottom, config = {}) => {
+    return findImageWithinBounds(image, left, top, right - left, bottom - top, config);
 };
 /**
  * 在指定方向上搜索图片
- * @param path 图片路径
+ * @param image 图片路径 或 图片矩阵
  * @param direction 搜索方向
  * @param config 识别对象配置
  * @returns 如果找到匹配的图片区域，则返回该区域
  */
-export const findImageInDirection = (path, direction, config = {}) => {
+export const findImageInDirection = (image, direction, config = {}) => {
     const { x, y, w, h } = directionToBounds(direction);
-    return findImageWithinBounds(path, x, y, w, h, config);
+    return findImageWithinBounds(image, x, y, w, h, config);
 };
 /**
  * 在整个画面内搜索文本

package/dist/progress.d.ts

@@ -20,36 +20,37 @@ export type Progress = {
         remaining: string;
     };
 };
-/** 进度日志记录器 */
-export type ProgressLogger = (message: string, progress: Progress) => void;
+/** 进度消息格式化器 */
+export type ProgressFormatter = (logger: typeof log.info, message: string, progress: Progress) => void;
 export type ProgressTrackerConfig = {
-    /** 日志记录器 */
-    logger?: ProgressLogger;
-    /** 节流间隔（毫秒），默认3000 */
+    /** 消息格式化器 */
+    formatter?: ProgressFormatter;
+    /** 打印间隔（毫秒），默认3000 */
     interval?: number;
 };
 /** 进度递进选项 */
 export type ProgressTickOptions = {
-    /** 递进后打印消息 */
-    message?: string;
     /** 递进的幅度 */
     increment?: number;
+    /** 递进后打印消息 */
+    message?: string;
+    /** 强制打印 */
+    force?: boolean;
 };
 /** 进度追踪器 */
 export declare class ProgressTracker {
-    private total;
-    private current;
-    private startTime;
-    private readonly logger;
+    total: number;
+    current: number;
+    startTime: number;
+    private readonly formatter;
     private readonly interval;
     private lastPrintTime;
     constructor(total: number, config?: ProgressTrackerConfig);
-    private readonly defaultLogger;
-    tick(options?: ProgressTickOptions): void;
-    track(callback: (progress: Progress, shouldPrint: () => boolean, printed: () => void) => void): void;
+    private readonly defaultFormatter;
+    tick(options?: ProgressTickOptions): boolean;
     complete(message: string): void;
     reset(): void;
-    private print;
+    print(message: string, force?: boolean, logger?: typeof log.info): void;
     private shouldPrint;
     private printed;
     getProgress(): Progress;

package/dist/progress.js

@@ -4,43 +4,37 @@ export class ProgressTracker {
     total = 0;
     current = 0;
     startTime = Date.now();
-    logger;
+    formatter;
     interval;
     lastPrintTime = 0;
     constructor(total, config) {
-        const { logger, interval: throttleInterval = 3000 } = config || {};
+        const { formatter, interval = 3000 } = config || {};
         this.total = total;
-        this.logger = logger || this.defaultLogger;
-        this.interval = throttleInterval;
+        this.formatter = formatter || this.defaultFormatter;
+        this.interval = interval;
     }
-    defaultLogger = (message, progress) => {
-        log.info("[🚧 {pct} ⏳ {eta}]: {msg}", progress.formatted.percentage.padStart(6), progress.current > 0 && progress.elapsed > 0 ? progress.formatted.remaining : "--:--:--", message);
+    defaultFormatter = (logger, message, progress) => {
+        logger("[🚧 {pct} ⏳ {eta}]: {msg}", progress.formatted.percentage.padStart(6), progress.current > 0 && progress.elapsed > 0 ? progress.formatted.remaining : "--:--:--", message);
     };
     tick(options) {
-        const { message, increment = 1 } = options || {};
+        const { increment = 1, message, force = false } = options || {};
         this.current = Math.min(this.current + increment, this.total);
         if (message)
-            this.print(message);
-    }
-    track(callback) {
-        const progress = this.getProgress();
-        const shouldPrint = this.shouldPrint.bind(this);
-        const printed = this.printed.bind(this);
-        callback(progress, shouldPrint, printed);
+            this.print(message, force);
+        return this.current === this.total;
     }
     complete(message) {
         this.current = this.total;
-        if (message)
-            this.print(message, true);
+        this.print(message, true);
     }
     reset() {
         this.current = 0;
         this.startTime = Date.now();
         this.lastPrintTime = 0;
     }
-    print(message, force = false) {
+    print(message, force = false, logger = log.info) {
         if (force || this.shouldPrint()) {
-            this.logger(message, this.getProgress());
+            this.formatter(logger, message, this.getProgress());
             this.printed();
         }
     }

package/package.json

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