@midscene/shared 0.12.8 → 0.12.9-beta-20250319085532.0

package/dist/es/img.d.ts

@@ -1,7 +1,7 @@
 import { Buffer } from 'node:buffer';
 import Jimp from 'jimp';
-import { NodeType } from './constants.js';
 import { R as Rect } from './index-305e7a7e.js';
+import { NodeType } from './constants.js';
 
 interface Size {
     width: number;
@@ -102,7 +102,10 @@ declare function trimImage(image: string | Buffer): Promise<{
     width: number;
     height: number;
 } | null>;
-declare function paddingToMatchBlock(imageBase64: string, blockSize?: number): Promise<string>;
+declare function jimpFromBase64(base64: string): Promise<Jimp>;
+declare function paddingToMatchBlock(image: Jimp, blockSize?: number): Promise<Jimp>;
+declare function cropByRect(image: Jimp, rect: Rect): Promise<void>;
+declare function jimpToBase64(image: Jimp): Promise<string>;
 
 type ElementType = {
     locator?: string;
@@ -149,4 +152,4 @@ declare function savePositionImg(options: {
     outputPath: string;
 }): Promise<void>;
 
-export { base64Encoded, bufferFromBase64, compositeElementInfoImg, drawBoxOnImage, imageInfo, imageInfoOfBase64, paddingToMatchBlock, processImageElementInfo, resizeImg, resizeImgBase64, saveBase64Image, savePositionImg, transformImgPathToBase64, trimImage, zoomForGPT4o };
+export { base64Encoded, bufferFromBase64, compositeElementInfoImg, cropByRect, drawBoxOnImage, imageInfo, imageInfoOfBase64, jimpFromBase64, jimpToBase64, paddingToMatchBlock, processImageElementInfo, resizeImg, resizeImgBase64, saveBase64Image, savePositionImg, transformImgPathToBase64, trimImage, zoomForGPT4o };

package/dist/es/img.js

@@ -169,22 +169,31 @@ async function trimImage(image) {
     height: trimmedHeight
   };
 }
-async function paddingToMatchBlock(imageBase64, blockSize = 28) {
-  debugImg("paddingToMatchBlock start");
+async function jimpFromBase64(base64) {
   const Jimp = await getJimp();
-  const imageBuffer = await bufferFromBase642(imageBase64);
-  const image = await Jimp.read(imageBuffer);
+  const imageBuffer = await bufferFromBase642(base64);
+  return Jimp.read(imageBuffer);
+}
+async function paddingToMatchBlock(image, blockSize = 28) {
+  debugImg("paddingToMatchBlock start");
   const { width, height } = image.bitmap;
   const targetWidth = Math.ceil(width / blockSize) * blockSize;
   const targetHeight = Math.ceil(height / blockSize) * blockSize;
   if (targetWidth === width && targetHeight === height) {
-    return imageBase64;
+    return image;
   }
+  const Jimp = await getJimp();
   const paddedImage = new Jimp(targetWidth, targetHeight, 4294967295);
   paddedImage.composite(image, 0, 0);
-  const base64 = await paddedImage.getBase64Async(Jimp.MIME_JPEG);
-  debugImg("paddingToMatchBlock done");
-  return base64;
+  return paddedImage;
+}
+async function cropByRect(image, rect) {
+  const { left, top, width, height } = rect;
+  image.crop(left, top, width, height);
+}
+async function jimpToBase64(image) {
+  const Jimp = await getJimp();
+  return image.getBase64Async(Jimp.MIME_JPEG);
 }
 
 // src/img/box-select.ts
@@ -411,9 +420,12 @@ export {
   base64Encoded,
   bufferFromBase64,
   compositeElementInfoImg,
+  cropByRect,
   drawBoxOnImage,
   imageInfo,
   imageInfoOfBase64,
+  jimpFromBase64,
+  jimpToBase64,
   paddingToMatchBlock,
   processImageElementInfo,
   resizeImg,

package/dist/es/utils.d.ts

@@ -13,5 +13,6 @@ declare function generateHashId(rect: any, content?: string): string;
  * @throws Error with the provided message if the condition is false
  */
 declare function assert(condition: any, message?: string): asserts condition;
+declare function getGlobalScope(): typeof globalThis | undefined;
 
-export { assert, enableDebug, generateHashId, getDebug, ifInBrowser, uuid };
+export { assert, enableDebug, generateHashId, getDebug, getGlobalScope, ifInBrowser, uuid };

package/dist/es/utils.js

@@ -44,11 +44,24 @@ function assert(condition, message) {
     throw new Error(message || "Assertion failed");
   }
 }
+function getGlobalScope() {
+  if (typeof window !== "undefined") {
+    return window;
+  }
+  if (typeof global !== "undefined") {
+    return global;
+  }
+  if (typeof self !== "undefined") {
+    return self;
+  }
+  return void 0;
+}
 export {
   assert,
   enableDebug,
   generateHashId,
   getDebug,
+  getGlobalScope,
   ifInBrowser,
   uuid
 };

package/dist/lib/img.d.ts

@@ -1,7 +1,7 @@
 import { Buffer } from 'node:buffer';
 import Jimp from 'jimp';
-import { NodeType } from './constants.js';
 import { R as Rect } from './index-305e7a7e.js';
+import { NodeType } from './constants.js';
 
 interface Size {
     width: number;
@@ -102,7 +102,10 @@ declare function trimImage(image: string | Buffer): Promise<{
     width: number;
     height: number;
 } | null>;
-declare function paddingToMatchBlock(imageBase64: string, blockSize?: number): Promise<string>;
+declare function jimpFromBase64(base64: string): Promise<Jimp>;
+declare function paddingToMatchBlock(image: Jimp, blockSize?: number): Promise<Jimp>;
+declare function cropByRect(image: Jimp, rect: Rect): Promise<void>;
+declare function jimpToBase64(image: Jimp): Promise<string>;
 
 type ElementType = {
     locator?: string;
@@ -149,4 +152,4 @@ declare function savePositionImg(options: {
     outputPath: string;
 }): Promise<void>;
 
-export { base64Encoded, bufferFromBase64, compositeElementInfoImg, drawBoxOnImage, imageInfo, imageInfoOfBase64, paddingToMatchBlock, processImageElementInfo, resizeImg, resizeImgBase64, saveBase64Image, savePositionImg, transformImgPathToBase64, trimImage, zoomForGPT4o };
+export { base64Encoded, bufferFromBase64, compositeElementInfoImg, cropByRect, drawBoxOnImage, imageInfo, imageInfoOfBase64, jimpFromBase64, jimpToBase64, paddingToMatchBlock, processImageElementInfo, resizeImg, resizeImgBase64, saveBase64Image, savePositionImg, transformImgPathToBase64, trimImage, zoomForGPT4o };

package/dist/lib/img.js

@@ -33,9 +33,12 @@ __export(img_exports, {
   base64Encoded: () => base64Encoded,
   bufferFromBase64: () => bufferFromBase64,
   compositeElementInfoImg: () => compositeElementInfoImg,
+  cropByRect: () => cropByRect,
   drawBoxOnImage: () => drawBoxOnImage,
   imageInfo: () => imageInfo,
   imageInfoOfBase64: () => imageInfoOfBase64,
+  jimpFromBase64: () => jimpFromBase64,
+  jimpToBase64: () => jimpToBase64,
   paddingToMatchBlock: () => paddingToMatchBlock,
   processImageElementInfo: () => processImageElementInfo,
   resizeImg: () => resizeImg,
@@ -219,22 +222,31 @@ async function trimImage(image) {
     height: trimmedHeight
   };
 }
-async function paddingToMatchBlock(imageBase64, blockSize = 28) {
-  debugImg("paddingToMatchBlock start");
+async function jimpFromBase64(base64) {
   const Jimp = await getJimp();
-  const imageBuffer = await bufferFromBase642(imageBase64);
-  const image = await Jimp.read(imageBuffer);
+  const imageBuffer = await bufferFromBase642(base64);
+  return Jimp.read(imageBuffer);
+}
+async function paddingToMatchBlock(image, blockSize = 28) {
+  debugImg("paddingToMatchBlock start");
   const { width, height } = image.bitmap;
   const targetWidth = Math.ceil(width / blockSize) * blockSize;
   const targetHeight = Math.ceil(height / blockSize) * blockSize;
   if (targetWidth === width && targetHeight === height) {
-    return imageBase64;
+    return image;
   }
+  const Jimp = await getJimp();
   const paddedImage = new Jimp(targetWidth, targetHeight, 4294967295);
   paddedImage.composite(image, 0, 0);
-  const base64 = await paddedImage.getBase64Async(Jimp.MIME_JPEG);
-  debugImg("paddingToMatchBlock done");
-  return base64;
+  return paddedImage;
+}
+async function cropByRect(image, rect) {
+  const { left, top, width, height } = rect;
+  image.crop(left, top, width, height);
+}
+async function jimpToBase64(image) {
+  const Jimp = await getJimp();
+  return image.getBase64Async(Jimp.MIME_JPEG);
 }
 
 // src/img/box-select.ts
@@ -462,9 +474,12 @@ async function savePositionImg(options) {
   base64Encoded,
   bufferFromBase64,
   compositeElementInfoImg,
+  cropByRect,
   drawBoxOnImage,
   imageInfo,
   imageInfoOfBase64,
+  jimpFromBase64,
+  jimpToBase64,
   paddingToMatchBlock,
   processImageElementInfo,
   resizeImg,

package/dist/lib/utils.d.ts

@@ -13,5 +13,6 @@ declare function generateHashId(rect: any, content?: string): string;
  * @throws Error with the provided message if the condition is false
  */
 declare function assert(condition: any, message?: string): asserts condition;
+declare function getGlobalScope(): typeof globalThis | undefined;
 
-export { assert, enableDebug, generateHashId, getDebug, ifInBrowser, uuid };
+export { assert, enableDebug, generateHashId, getDebug, getGlobalScope, ifInBrowser, uuid };

package/dist/lib/utils.js

@@ -34,6 +34,7 @@ __export(utils_exports, {
   enableDebug: () => enableDebug,
   generateHashId: () => generateHashId,
   getDebug: () => getDebug,
+  getGlobalScope: () => getGlobalScope,
   ifInBrowser: () => ifInBrowser,
   uuid: () => uuid
 });
@@ -83,12 +84,25 @@ function assert(condition, message) {
     throw new Error(message || "Assertion failed");
   }
 }
+function getGlobalScope() {
+  if (typeof window !== "undefined") {
+    return window;
+  }
+  if (typeof global !== "undefined") {
+    return global;
+  }
+  if (typeof self !== "undefined") {
+    return self;
+  }
+  return void 0;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   assert,
   enableDebug,
   generateHashId,
   getDebug,
+  getGlobalScope,
   ifInBrowser,
   uuid
 });

package/dist/types/img.d.ts

@@ -1,7 +1,7 @@
 import { Buffer } from 'node:buffer';
 import Jimp from 'jimp';
-import { NodeType } from './constants.js';
 import { R as Rect } from './index-305e7a7e.js';
+import { NodeType } from './constants.js';
 
 interface Size {
     width: number;
@@ -102,7 +102,10 @@ declare function trimImage(image: string | Buffer): Promise<{
     width: number;
     height: number;
 } | null>;
-declare function paddingToMatchBlock(imageBase64: string, blockSize?: number): Promise<string>;
+declare function jimpFromBase64(base64: string): Promise<Jimp>;
+declare function paddingToMatchBlock(image: Jimp, blockSize?: number): Promise<Jimp>;
+declare function cropByRect(image: Jimp, rect: Rect): Promise<void>;
+declare function jimpToBase64(image: Jimp): Promise<string>;
 
 type ElementType = {
     locator?: string;
@@ -149,4 +152,4 @@ declare function savePositionImg(options: {
     outputPath: string;
 }): Promise<void>;
 
-export { base64Encoded, bufferFromBase64, compositeElementInfoImg, drawBoxOnImage, imageInfo, imageInfoOfBase64, paddingToMatchBlock, processImageElementInfo, resizeImg, resizeImgBase64, saveBase64Image, savePositionImg, transformImgPathToBase64, trimImage, zoomForGPT4o };
+export { base64Encoded, bufferFromBase64, compositeElementInfoImg, cropByRect, drawBoxOnImage, imageInfo, imageInfoOfBase64, jimpFromBase64, jimpToBase64, paddingToMatchBlock, processImageElementInfo, resizeImg, resizeImgBase64, saveBase64Image, savePositionImg, transformImgPathToBase64, trimImage, zoomForGPT4o };

package/dist/types/utils.d.ts

@@ -13,5 +13,6 @@ declare function generateHashId(rect: any, content?: string): string;
  * @throws Error with the provided message if the condition is false
  */
 declare function assert(condition: any, message?: string): asserts condition;
+declare function getGlobalScope(): typeof globalThis | undefined;
 
-export { assert, enableDebug, generateHashId, getDebug, ifInBrowser, uuid };
+export { assert, enableDebug, generateHashId, getDebug, getGlobalScope, ifInBrowser, uuid };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midscene/shared",
-  "version": "0.12.8",
+  "version": "0.12.9-beta-20250319085532.0",
   "repository": "https://github.com/web-infra-dev/midscene",
   "homepage": "https://midscenejs.com/",
   "types": "./dist/types/index.d.ts",

package/src/img/index.ts

@@ -12,6 +12,9 @@ export {
   zoomForGPT4o,
   saveBase64Image,
   paddingToMatchBlock,
+  cropByRect,
+  jimpFromBase64,
+  jimpToBase64,
 } from './transform';
 export { processImageElementInfo, compositeElementInfoImg } from './box-select';
 export { drawBoxOnImage, savePositionImg } from './draw-box';

package/src/img/transform.ts

@@ -1,8 +1,10 @@
 import assert from 'node:assert';
 import { Buffer } from 'node:buffer';
+
 import getDebug from 'debug';
+import type Jimp from 'jimp';
+import type { Rect } from 'src/types';
 import getJimp from './get-jimp';
-
 const debugImg = getDebug('img');
 /**
 /**
@@ -210,26 +212,40 @@ export function prependBase64Header(base64: string, mimeType = 'image/png') {
   return `data:${mimeType};base64,${base64}`;
 }
 
-export async function paddingToMatchBlock(imageBase64: string, blockSize = 28) {
-  debugImg('paddingToMatchBlock start');
+export async function jimpFromBase64(base64: string): Promise<Jimp> {
   const Jimp = await getJimp();
-  const imageBuffer = await bufferFromBase64(imageBase64);
-  const image = await Jimp.read(imageBuffer);
+  const imageBuffer = await bufferFromBase64(base64);
+  return Jimp.read(imageBuffer);
+}
+
+export async function paddingToMatchBlock(
+  image: Jimp,
+  blockSize = 28,
+): Promise<Jimp> {
+  debugImg('paddingToMatchBlock start');
   const { width, height } = image.bitmap;
 
   const targetWidth = Math.ceil(width / blockSize) * blockSize;
   const targetHeight = Math.ceil(height / blockSize) * blockSize;
 
   if (targetWidth === width && targetHeight === height) {
-    return imageBase64;
+    return image;
   }
 
+  const Jimp = await getJimp();
   const paddedImage = new Jimp(targetWidth, targetHeight, 0xffffffff);
 
   // Composite the original image onto the new canvas
   paddedImage.composite(image, 0, 0);
+  return paddedImage;
+}
 
-  const base64 = await paddedImage.getBase64Async(Jimp.MIME_JPEG);
-  debugImg('paddingToMatchBlock done');
-  return base64;
+export async function cropByRect(image: Jimp, rect: Rect): Promise<void> {
+  const { left, top, width, height } = rect;
+  image.crop(left, top, width, height);
+}
+
+export async function jimpToBase64(image: Jimp): Promise<string> {
+  const Jimp = await getJimp();
+  return image.getBase64Async(Jimp.MIME_JPEG);
 }

package/src/utils.ts

@@ -68,3 +68,18 @@ export function assert(condition: any, message?: string): asserts condition {
     throw new Error(message || 'Assertion failed');
   }
 }
+
+export function getGlobalScope() {
+  if (typeof window !== 'undefined') {
+    return window;
+  }
+
+  if (typeof global !== 'undefined') {
+    return global;
+  }
+
+  if (typeof self !== 'undefined') {
+    return self;
+  }
+  return undefined;
+}