@solazah/solazah-runtime 0.2.33 → 0.2.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solazah/solazah-runtime",
-  "version": "0.2.33",
+  "version": "0.2.36",
   "main": "index.cjs",
   "module": "index.js",
   "types": "types/index.d.ts",

package/types/SystemOCR.d.ts

@@ -6,6 +6,22 @@ export interface OCRTextBlock {
     /** 四个角点坐标,顺时针或逆时针,不是 x/y/width/height 矩形 */
     box: [number, number][];
 }
+/** 检测结果,与主进程 OcrProtocol 的 OcrDetection 同构(真源在那里)。 */
+export interface OCRDetection {
+    /** 帧句柄,交给 recognizeBoxes 按框取字。 */
+    frame: string;
+    width: number;
+    height: number;
+    /** 文字框,每个是四个角点坐标(顺时针,从左上起),按阅读顺序排列;recognizeBoxes 的 indices 指的就是这里的序号。 */
+    boxes: [number, number][][];
+}
+/** 按框识别的结果,与主进程 OcrProtocol 的 OcrBoxTexts 同构(真源在那里)。 */
+export type OCRBoxTexts = {
+    found: true;
+    texts: Array<OCRTextBlock | null>;
+} | {
+    found: false;
+};
 export default class SystemOCR {
     private transport;
     constructor(transport?: IpcRenderer);
@@ -17,4 +33,31 @@ export default class SystemOCR {
      * @throws 图片解码失败或 OCR 引擎未就绪时抛错。
      */
     recognize: (base64String: string) => Promise<OCRTextBlock[]>;
+    /**
+     * 两步式识别的第一步:只检测出文字框,不认字。检测只占整图识别耗时的一小部分,大头是逐框认字;
+     * 先要框的位置(如框选、高亮)时用它,文字再用 recognizeBoxes 按需取。
+     * 同一张图重复调用命中缓存,直接返回同一个帧句柄。
+     *
+     * @param base64String Base64 编码的图片数据(PNG、JPEG、BMP)。
+     * @returns frame(帧句柄)、width/height(图片尺寸)、boxes(文字框,阅读顺序)。
+     * @throws 图片解码失败或 OCR 引擎未就绪时抛错。
+     */
+    detect: (base64String: string) => Promise<OCRDetection>;
+    /**
+     * 两步式识别的第二步:按框认字。已认过的框直接返回,同一个框不会重复推理。
+     *
+     * 返回 found: false 表示这一帧已不在引擎里(之后检测的图太多把它挤出、OCR 进程空闲回收或重启),
+     * 或要的框里有没认过的、而这一帧的原图已经释放(之后又有几张图检测完在等补字,引擎只给最近用过的几张留原图);
+     * 这是预期内的结果,不是失败:用同一张图重新 detect,拿新的 frame 再取(框的序号不变)。
+     *
+     * @param frame detect 返回的帧句柄。
+     * @param indices 要认的框在 detect 返回的 boxes 里的序号。
+     * @param options background 为 true 时排在一切前台请求之后,适合在后台分批把整帧补齐;
+     *                用户正在看、正在选的框不要带它。
+     * @returns found 为 true 时 texts 与 indices 一一对应,框里认不出字为 null。
+     * @throws 序号越界或 OCR 引擎出错时抛错。
+     */
+    recognizeBoxes: (frame: string, indices: number[], options?: {
+        background?: boolean;
+    }) => Promise<OCRBoxTexts>;
 }