@midscene/core 0.0.1 → 0.1.1

package/dist/lib/utils.js

@@ -32,6 +32,7 @@ var utils_exports = {};
 __export(utils_exports, {
   commonScreenshotParam: () => commonScreenshotParam,
   getDumpDir: () => getDumpDir,
+  getDumpDirPath: () => getDumpDirPath,
   getPkgInfo: () => getPkgInfo,
   getTmpDir: () => getTmpDir,
   getTmpFile: () => getTmpFile,
@@ -80,13 +81,18 @@ function getDumpDir() {
 function setDumpDir(dir) {
   logDir = dir;
 }
-function writeDumpFile(fileName, fileExt, fileContent) {
+function getDumpDirPath(type) {
+  return (0, import_path.join)(getDumpDir(), type);
+}
+function writeDumpFile(opts) {
+  const { fileName, fileExt, fileContent, type = "dump" } = opts;
+  const targetDir = getDumpDirPath(type);
+  if (!(0, import_fs.existsSync)(targetDir)) {
+    (0, import_fs.mkdirSync)(targetDir, { recursive: true });
+  }
   if (!logEnvReady) {
-    (0, import_assert.default)(logDir, "logDir should be set before writing dump file");
-    if (!(0, import_fs.existsSync)(logDir)) {
-      (0, import_fs.mkdirSync)(logDir, { recursive: true });
-    }
-    const gitIgnorePath = (0, import_path.join)(logDir, "../.gitignore");
+    (0, import_assert.default)(targetDir, "logDir should be set before writing dump file");
+    const gitIgnorePath = (0, import_path.join)(targetDir, "../../.gitignore");
     let gitIgnoreContent = "";
     if ((0, import_fs.existsSync)(gitIgnorePath)) {
       gitIgnoreContent = (0, import_fs.readFileSync)(gitIgnorePath, "utf-8");
@@ -97,16 +103,19 @@ function writeDumpFile(fileName, fileExt, fileContent) {
         gitIgnorePath,
         `${gitIgnoreContent}
 # MidScene.js dump files
-${logDirName}/
+${logDirName}/midscene-report
+${logDirName}/dump-logger
 `,
         "utf-8"
       );
     }
     logEnvReady = true;
   }
-  const filePath = (0, import_path.join)(getDumpDir(), `${fileName}.${fileExt}`);
+  const filePath = (0, import_path.join)(targetDir, `${fileName}.${fileExt}`);
   (0, import_fs.writeFileSync)(filePath, fileContent);
-  (0, import_fs.copyFileSync)(filePath, (0, import_path.join)(getDumpDir(), `latest.${fileExt}`));
+  if (type === "dump") {
+    (0, import_fs.copyFileSync)(filePath, (0, import_path.join)(targetDir, `latest.${fileExt}`));
+  }
   return filePath;
 }
 function getTmpDir() {
@@ -114,8 +123,8 @@ function getTmpDir() {
   (0, import_fs.mkdirSync)(path, { recursive: true });
   return path;
 }
-function getTmpFile(fileExt) {
-  const filename = `${(0, import_crypto.randomUUID)()}.${fileExt}`;
+function getTmpFile(fileExtWithoutDot) {
+  const filename = `${(0, import_crypto.randomUUID)()}.${fileExtWithoutDot}`;
   return (0, import_path.join)(getTmpDir(), filename);
 }
 function overlapped(container, target) {
@@ -129,6 +138,7 @@ var commonScreenshotParam = { type: "jpeg", quality: 75 };
 0 && (module.exports = {
   commonScreenshotParam,
   getDumpDir,
+  getDumpDirPath,
   getPkgInfo,
   getTmpDir,
   getTmpFile,

package/dist/types/ai-model.d.ts

@@ -9,7 +9,7 @@ declare function AiInspectElement<ElementType extends BaseElement = BaseElement>
     context: UIContext<ElementType>;
     multi: boolean;
     findElementDescription: string;
-    callAI?: typeof callToGetJSONObject;
+    callAI?: typeof callToGetJSONObject<AIElementParseResponse>;
 }): Promise<{
     parseResult: AIElementParseResponse;
     elementById: (id: string) => ElementType;

package/dist/types/image.d.ts

@@ -1,6 +1,5 @@
-import { Buffer } from 'buffer';
+import { Buffer } from 'node:buffer';
 import { S as Size, R as Rect, g as UISection, U as UIContext, t as Color } from './types-1f7912d5.js';
-import { Buffer as Buffer$1 } from 'node:buffer';
 import 'openai/resources';
 
 /**
@@ -79,7 +78,7 @@ declare function calculateNewDimensions(originalWidth: number, originalHeight: n
  * @param image - The image to be trimmed. This can be a file path or a Buffer object containing the image data
  * @returns A Promise that resolves to an object containing the trimming information. If the image does not need to be trimmed, this object will be null
  */
-declare function trimImage(image: string | Buffer$1): Promise<{
+declare function trimImage(image: string | Buffer): Promise<{
     trimOffsetLeft: number;
     trimOffsetTop: number;
     width: number;
@@ -101,7 +100,7 @@ declare function trimImage(image: string | Buffer$1): Promise<{
  * @returns A Promise that resolves to a rectangle object representing the aligned coordinates
  * @throws Error if there is an error during image processing
  */
-declare function alignCoordByTrim(image: string | Buffer$1, center: Rect): Promise<Rect>;
+declare function alignCoordByTrim(image: string | Buffer, centerRect: Rect): Promise<Rect>;
 
 /**
  * Composes a section diagram based on the given sections and context

package/dist/types/index.d.ts

@@ -4,19 +4,26 @@ export { e as AIElementParseResponse, A as AIResponseFormat, f as AISectionParse
 export { setDumpDir } from './utils.js';
 import 'openai/resources';
 
-declare class Insight<ElementType extends BaseElement = BaseElement> {
-    contextRetrieverFn: () => Promise<UIContext<ElementType>> | UIContext<ElementType>;
+interface LocateOpts {
+    multi?: boolean;
+    callAI?: typeof callToGetJSONObject<AIElementParseResponse>;
+}
+declare class Insight<ElementType extends BaseElement = BaseElement, ContextType extends UIContext<ElementType> = UIContext<ElementType>> {
+    contextRetrieverFn: () => Promise<ContextType> | ContextType;
     aiVendorFn: typeof callToGetJSONObject;
     onceDumpUpdatedFn?: DumpSubscriber;
     taskInfo?: Omit<InsightTaskInfo, 'durationMs'>;
-    constructor(context: UIContext<ElementType> | (() => Promise<UIContext<ElementType>> | UIContext<ElementType>), opt?: InsightOptions);
-    locate(queryPrompt: string): Promise<ElementType | null>;
+    constructor(context: ContextType | (() => Promise<ContextType> | ContextType), opt?: InsightOptions);
+    locate(queryPrompt: string, opt?: {
+        callAI: LocateOpts['callAI'];
+    }): Promise<ElementType | null>;
     locate(queryPrompt: string, opt: {
         multi: true;
     }): Promise<ElementType[]>;
     extract<T = any>(input: string): Promise<T>;
     extract<T extends Record<string, string>>(input: T): Promise<Record<keyof T, any>>;
     extract<T extends object>(input: Record<keyof T, string>): Promise<T>;
+    setAiVendorFn<T>(aiVendorFn: typeof callToGetJSONObject<T>): () => void;
 }
 
 declare class Executor {
@@ -36,7 +43,10 @@ declare class Executor {
 declare const getElement: typeof retrieveElement;
 declare const getSection: typeof retrieveSection;
 
-declare function plan(context: UIContext, userPrompt: string): Promise<{
+declare function plan(userPrompt: string, opts: {
+    context: UIContext;
+    callAI?: typeof callToGetJSONObject<PlanningAIResponse>;
+}): Promise<{
     plans: PlanningAction[];
 }>;
 

package/dist/types/utils.d.ts

@@ -10,11 +10,17 @@ declare const insightDumpFileExt = "insight-dump.json";
 declare const groupedActionDumpFileExt = "web-dump.json";
 declare function getDumpDir(): string;
 declare function setDumpDir(dir: string): void;
-declare function writeDumpFile(fileName: string, fileExt: string, fileContent: string): string;
+declare function getDumpDirPath(type: 'dump' | 'cache'): string;
+declare function writeDumpFile(opts: {
+    fileName: string;
+    fileExt: string;
+    fileContent: string;
+    type?: 'dump' | 'cache';
+}): string;
 declare function getTmpDir(): string;
-declare function getTmpFile(fileExt: string): string;
+declare function getTmpFile(fileExtWithoutDot: string): string;
 declare function overlapped(container: Rect, target: Rect): boolean;
 declare function sleep(ms: number): Promise<unknown>;
 declare const commonScreenshotParam: any;
 
-export { commonScreenshotParam, getDumpDir, getPkgInfo, getTmpDir, getTmpFile, groupedActionDumpFileExt, insightDumpFileExt, overlapped, setDumpDir, sleep, writeDumpFile };
+export { commonScreenshotParam, getDumpDir, getDumpDirPath, getPkgInfo, getTmpDir, getTmpFile, groupedActionDumpFileExt, insightDumpFileExt, overlapped, setDumpDir, sleep, writeDumpFile };

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@midscene/core",
   "description": "Hello, It's MidScene",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "jsnext:source": "./src/index.ts",
   "main": "./dist/lib/index.js",
   "module": "./dist/es/index.js",
   "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",

package/.eslintignore

@@ -1,3 +0,0 @@
-demo_data
-vitest.config.ts
-modern.config.ts

package/.eslintrc.js

@@ -1,9 +0,0 @@
-module.exports = {
-  root: true,
-  rules: {
-    '@typescript-eslint/no-explicit-any': 'warn',
-    '@typescript-eslint/no-magic-numbers': 'off',
-    '@typescript-eslint/no-parameter-properties': 'off',
-  },
-  extends: ['@modern-js'],
-};

package/CONTRIBUTING.md

@@ -1,5 +0,0 @@
-It's all driven by tests:
-
-```shell
-npx vitest ./tests/
-```