@midscene/web 0.3.2 → 0.3.3

package/dist/types/debug.d.ts

@@ -0,0 +1,17 @@
+import { writeFileSync } from 'node:fs';
+import { W as WebPage } from './page.d-70ed000f.js';
+import 'playwright';
+import 'puppeteer';
+
+declare function generateExtractData(page: WebPage, targetDir: string, saveImgType?: {
+    disableInputImage: boolean;
+    disableOutputImage: boolean;
+    disableOutputWithoutTextImg: boolean;
+    disableResizeOutputImg: boolean;
+    disableSnapshot: boolean;
+}): Promise<void>;
+declare function generateTestDataPath(testDataName: string): string;
+type WriteFileSyncParams = Parameters<typeof writeFileSync>;
+declare function writeFileSyncWithDir(filePath: string, content: WriteFileSyncParams[1], options?: WriteFileSyncParams[2]): void;
+
+export { generateExtractData, generateTestDataPath, writeFileSyncWithDir };

package/dist/types/index.d.ts

@@ -1,191 +1,11 @@
-import { AgentWaitForOpt } from '@midscene/core/.';
-import { TestInfo } from '@playwright/test';
-import { Page } from 'playwright';
-import { Page as Page$1 } from 'puppeteer';
-import Insight, { BaseElement, Rect, UIContext, PlanningAction, AIElementParseResponse, InsightExtractParam, InsightAssertionResponse, PlanningActionParamWaitFor, Executor, GroupedActionDump, ExecutionDump, AgentWaitForOpt as AgentWaitForOpt$1 } from '@midscene/core';
-
-type WebPage = Page | Page$1;
-
-declare enum NodeType {
-    INPUT = "INPUT Node",
-    BUTTON = "BUTTON Node",
-    IMG = "IMG Node",
-    TEXT = "TEXT Node"
-}
-
-declare class WebElementInfo implements BaseElement {
-    content: string;
-    locator: string;
-    rect: Rect;
-    center: [number, number];
-    page: WebPage;
-    id: string;
-    attributes: {
-        nodeType: NodeType;
-        [key: string]: string;
-    };
-    constructor({ content, rect, page, locator, id, attributes, }: {
-        content: string;
-        rect: Rect;
-        page: WebPage;
-        locator: string;
-        id: string;
-        attributes: {
-            nodeType: NodeType;
-            [key: string]: string;
-        };
-    });
-}
-
-type WebUIContext = UIContext<WebElementInfo> & {
-    url: string;
-};
-
-type PlanTask = {
-    type: 'plan';
-    prompt: string;
-    pageContext: {
-        url: string;
-        size: {
-            width: number;
-            height: number;
-        };
-    };
-    response: {
-        plans: PlanningAction[];
-    };
-};
-type LocateTask = {
-    type: 'locate';
-    prompt: string;
-    pageContext: {
-        url: string;
-        size: {
-            width: number;
-            height: number;
-        };
-    };
-    response: AIElementParseResponse;
-};
-type AiTasks = Array<PlanTask | LocateTask>;
-type AiTaskCache = {
-    aiTasks: AiTasks;
-};
-declare class TaskCache {
-    cache: AiTaskCache | undefined;
-    newCache: AiTaskCache;
-    constructor(opts?: {
-        cache: AiTaskCache;
-    });
-    /**
-     * Read and return cached responses asynchronously based on specific criteria
-     * This function is mainly used to read cached responses from a certain storage medium.
-     * It accepts three parameters: the page context information, the task type, and the user's prompt information.
-     * In the function, it first checks whether there is cached data. If there is, it retrieves the first task response from the cache.
-     * It then checks whether the task type is 'locate' and whether the corresponding element can be found in the new context.
-     * If the element cannot be found, it returns false, indicating that the cache is invalid.
-     * If the task type is correct and the user prompt matches, it checks whether the page context is the same.
-     * If the page context is the same, it returns the cached response, indicating that the cache hit is successful.
-     * If there is no cached data or the conditions are not met, the function returns false, indicating that no cache is available or the cache is not hit.
-     *
-     * @param pageContext UIContext<WebElementInfo> type, representing the context information of the current page
-     * @param type String type, specifying the task type, can be 'plan' or 'locate'
-     * @param userPrompt String type, representing user prompt information
-     * @return Returns a Promise object that resolves to a boolean or object
-     */
-    readCache(pageContext: WebUIContext, type: 'plan', userPrompt: string): PlanTask['response'];
-    readCache(pageContext: WebUIContext, type: 'locate', userPrompt: string): LocateTask['response'];
-    saveCache(cache: PlanTask | LocateTask): void;
-    pageContextEqual(taskPageContext: LocateTask['pageContext'], pageContext: WebUIContext): boolean;
-    /**
-     * Generate task cache data.
-     * This method is mainly used to create or obtain some cached data for tasks, and it returns a new cache object.
-     * In the cache object, it may contain task-related information, states, or other necessary data.
-     * It is assumed that the `newCache` property already exists in the current class or object and is a data structure used to store task cache.
-     * @returns {Object} Returns a new cache object, which may include task cache data.
-     */
-    generateTaskCache(): AiTaskCache;
-}
-
-interface ExecutionResult<OutputType = any> {
-    output: OutputType;
-    executor: Executor;
-}
-declare class PageTaskExecutor {
-    page: WebPage;
-    insight: Insight<WebElementInfo, WebUIContext>;
-    taskCache: TaskCache;
-    constructor(page: WebPage, opts: {
-        cache: AiTaskCache;
-    });
-    private recordScreenshot;
-    private wrapExecutorWithScreenshot;
-    private convertPlanToExecutable;
-    action(userPrompt: string): Promise<ExecutionResult>;
-    query(demand: InsightExtractParam): Promise<ExecutionResult>;
-    assert(assertion: string): Promise<ExecutionResult<InsightAssertionResponse>>;
-    waitFor(assertion: string, opt: PlanningActionParamWaitFor): Promise<ExecutionResult<void>>;
-}
-
-declare const PlaywrightAiFixture: () => {
-    ai: ({ page }: {
-        page: Page;
-    }, use: any, testInfo: TestInfo) => Promise<void>;
-    aiAction: ({ page }: {
-        page: Page;
-    }, use: any, testInfo: TestInfo) => Promise<void>;
-    aiQuery: ({ page }: {
-        page: Page;
-    }, use: any, testInfo: TestInfo) => Promise<void>;
-    aiAssert: ({ page }: {
-        page: Page;
-    }, use: any, testInfo: TestInfo) => Promise<void>;
-    aiWaitFor: ({ page }: {
-        page: Page;
-    }, use: any, testInfo: TestInfo) => Promise<void>;
-};
-type PlayWrightAiFixtureType = {
-    ai: <T = any>(prompt: string, opts?: {
-        type?: 'action' | 'query';
-    }) => Promise<T>;
-    aiAction: (taskPrompt: string) => ReturnType<PageTaskExecutor['action']>;
-    aiQuery: <T = any>(demand: any) => Promise<T>;
-    aiAssert: (assertion: string, errorMsg?: string) => Promise<void>;
-    aiWaitFor: (assertion: string, opt?: AgentWaitForOpt) => Promise<void>;
-};
-
-interface PageAgentOpt {
-    testId?: string;
-    groupName?: string;
-    groupDescription?: string;
-    cache?: AiTaskCache;
-    generateReport?: boolean;
-    autoPrintReportMsg?: boolean;
-}
-declare class PageAgent {
-    page: WebPage;
-    dump: GroupedActionDump;
-    reportFile?: string;
-    reportFileName?: string;
-    taskExecutor: PageTaskExecutor;
-    opts: PageAgentOpt;
-    constructor(page: WebPage, opts?: PageAgentOpt);
-    appendExecutionDump(execution: ExecutionDump): void;
-    dumpDataString(): string;
-    writeOutActionDumps(): void;
-    aiAction(taskPrompt: string): Promise<void>;
-    aiQuery(demand: any): Promise<any>;
-    aiAssert(assertion: string, msg?: string): Promise<void>;
-    aiWaitFor(assertion: string, opt?: AgentWaitForOpt$1): Promise<void>;
-    ai(taskPrompt: string, type?: string): Promise<any>;
-}
-
-declare function generateExtractData(page: WebPage, targetDir: string, saveImgType?: {
-    disableInputImage: boolean;
-    disableOutputImage: boolean;
-    disableOutputWithoutTextImg: boolean;
-    disableResizeOutputImg: boolean;
-    disableSnapshot: boolean;
-}): Promise<void>;
-
-export { type PlayWrightAiFixtureType, PlaywrightAiFixture, PageAgent as PuppeteerAgent, generateExtractData };
+export { PlayWrightAiFixtureType, PlaywrightAiFixture } from './playwright.js';
+export { PuppeteerAgent } from './puppeteer.js';
+export { generateExtractData } from './debug.js';
+import '@midscene/core/.';
+import '@playwright/test';
+import 'playwright';
+import './tasks-75eae15e.js';
+import './page.d-70ed000f.js';
+import 'puppeteer';
+import '@midscene/core';
+import 'node:fs';

package/dist/types/page.d-70ed000f.d.ts

@@ -0,0 +1,6 @@
+import { Page } from 'playwright';
+import { Page as Page$1 } from 'puppeteer';
+
+type WebPage = Page | Page$1;
+
+export type { WebPage as W };

package/dist/types/playwright.d.ts

@@ -0,0 +1,36 @@
+import { AgentWaitForOpt } from '@midscene/core/.';
+import { TestInfo } from '@playwright/test';
+import { Page } from 'playwright';
+import { P as PageTaskExecutor } from './tasks-75eae15e.js';
+import './page.d-70ed000f.js';
+import 'puppeteer';
+import '@midscene/core';
+
+declare const PlaywrightAiFixture: () => {
+    ai: ({ page }: {
+        page: Page;
+    }, use: any, testInfo: TestInfo) => Promise<void>;
+    aiAction: ({ page }: {
+        page: Page;
+    }, use: any, testInfo: TestInfo) => Promise<void>;
+    aiQuery: ({ page }: {
+        page: Page;
+    }, use: any, testInfo: TestInfo) => Promise<void>;
+    aiAssert: ({ page }: {
+        page: Page;
+    }, use: any, testInfo: TestInfo) => Promise<void>;
+    aiWaitFor: ({ page }: {
+        page: Page;
+    }, use: any, testInfo: TestInfo) => Promise<void>;
+};
+type PlayWrightAiFixtureType = {
+    ai: <T = any>(prompt: string, opts?: {
+        type?: 'action' | 'query';
+    }) => Promise<T>;
+    aiAction: (taskPrompt: string) => ReturnType<PageTaskExecutor['action']>;
+    aiQuery: <T = any>(demand: any) => Promise<T>;
+    aiAssert: (assertion: string, errorMsg?: string) => Promise<void>;
+    aiWaitFor: (assertion: string, opt?: AgentWaitForOpt) => Promise<void>;
+};
+
+export { type PlayWrightAiFixtureType, PlaywrightAiFixture };

package/dist/types/puppeteer.d.ts

@@ -0,0 +1,33 @@
+import { W as WebPage } from './page.d-70ed000f.js';
+import { GroupedActionDump, ExecutionDump, AgentWaitForOpt } from '@midscene/core';
+import { P as PageTaskExecutor, A as AiTaskCache } from './tasks-75eae15e.js';
+import 'playwright';
+import 'puppeteer';
+
+interface PageAgentOpt {
+    testId?: string;
+    groupName?: string;
+    groupDescription?: string;
+    cache?: AiTaskCache;
+    generateReport?: boolean;
+    autoPrintReportMsg?: boolean;
+}
+declare class PageAgent {
+    page: WebPage;
+    dump: GroupedActionDump;
+    reportFile?: string;
+    reportFileName?: string;
+    taskExecutor: PageTaskExecutor;
+    opts: PageAgentOpt;
+    constructor(page: WebPage, opts?: PageAgentOpt);
+    appendExecutionDump(execution: ExecutionDump): void;
+    dumpDataString(): string;
+    writeOutActionDumps(): void;
+    aiAction(taskPrompt: string): Promise<void>;
+    aiQuery(demand: any): Promise<any>;
+    aiAssert(assertion: string, msg?: string): Promise<void>;
+    aiWaitFor(assertion: string, opt?: AgentWaitForOpt): Promise<void>;
+    ai(taskPrompt: string, type?: string): Promise<any>;
+}
+
+export { PageAgent as PuppeteerAgent };

package/dist/types/tasks-75eae15e.d.ts

@@ -0,0 +1,125 @@
+import { W as WebPage } from './page.d-70ed000f.js';
+import Insight, { BaseElement, Rect, UIContext, PlanningAction, AIElementParseResponse, InsightExtractParam, InsightAssertionResponse, PlanningActionParamWaitFor, Executor } from '@midscene/core';
+
+declare enum NodeType {
+    INPUT = "INPUT Node",
+    BUTTON = "BUTTON Node",
+    IMG = "IMG Node",
+    TEXT = "TEXT Node"
+}
+
+declare class WebElementInfo implements BaseElement {
+    content: string;
+    locator: string;
+    rect: Rect;
+    center: [number, number];
+    page: WebPage;
+    id: string;
+    attributes: {
+        nodeType: NodeType;
+        [key: string]: string;
+    };
+    constructor({ content, rect, page, locator, id, attributes, }: {
+        content: string;
+        rect: Rect;
+        page: WebPage;
+        locator: string;
+        id: string;
+        attributes: {
+            nodeType: NodeType;
+            [key: string]: string;
+        };
+    });
+}
+
+type WebUIContext = UIContext<WebElementInfo> & {
+    url: string;
+};
+
+type PlanTask = {
+    type: 'plan';
+    prompt: string;
+    pageContext: {
+        url: string;
+        size: {
+            width: number;
+            height: number;
+        };
+    };
+    response: {
+        plans: PlanningAction[];
+    };
+};
+type LocateTask = {
+    type: 'locate';
+    prompt: string;
+    pageContext: {
+        url: string;
+        size: {
+            width: number;
+            height: number;
+        };
+    };
+    response: AIElementParseResponse;
+};
+type AiTasks = Array<PlanTask | LocateTask>;
+type AiTaskCache = {
+    aiTasks: AiTasks;
+};
+declare class TaskCache {
+    cache: AiTaskCache | undefined;
+    newCache: AiTaskCache;
+    constructor(opts?: {
+        cache: AiTaskCache;
+    });
+    /**
+     * Read and return cached responses asynchronously based on specific criteria
+     * This function is mainly used to read cached responses from a certain storage medium.
+     * It accepts three parameters: the page context information, the task type, and the user's prompt information.
+     * In the function, it first checks whether there is cached data. If there is, it retrieves the first task response from the cache.
+     * It then checks whether the task type is 'locate' and whether the corresponding element can be found in the new context.
+     * If the element cannot be found, it returns false, indicating that the cache is invalid.
+     * If the task type is correct and the user prompt matches, it checks whether the page context is the same.
+     * If the page context is the same, it returns the cached response, indicating that the cache hit is successful.
+     * If there is no cached data or the conditions are not met, the function returns false, indicating that no cache is available or the cache is not hit.
+     *
+     * @param pageContext UIContext<WebElementInfo> type, representing the context information of the current page
+     * @param type String type, specifying the task type, can be 'plan' or 'locate'
+     * @param userPrompt String type, representing user prompt information
+     * @return Returns a Promise object that resolves to a boolean or object
+     */
+    readCache(pageContext: WebUIContext, type: 'plan', userPrompt: string): PlanTask['response'];
+    readCache(pageContext: WebUIContext, type: 'locate', userPrompt: string): LocateTask['response'];
+    saveCache(cache: PlanTask | LocateTask): void;
+    pageContextEqual(taskPageContext: LocateTask['pageContext'], pageContext: WebUIContext): boolean;
+    /**
+     * Generate task cache data.
+     * This method is mainly used to create or obtain some cached data for tasks, and it returns a new cache object.
+     * In the cache object, it may contain task-related information, states, or other necessary data.
+     * It is assumed that the `newCache` property already exists in the current class or object and is a data structure used to store task cache.
+     * @returns {Object} Returns a new cache object, which may include task cache data.
+     */
+    generateTaskCache(): AiTaskCache;
+}
+
+interface ExecutionResult<OutputType = any> {
+    output: OutputType;
+    executor: Executor;
+}
+declare class PageTaskExecutor {
+    page: WebPage;
+    insight: Insight<WebElementInfo, WebUIContext>;
+    taskCache: TaskCache;
+    constructor(page: WebPage, opts: {
+        cache: AiTaskCache;
+    });
+    private recordScreenshot;
+    private wrapExecutorWithScreenshot;
+    private convertPlanToExecutable;
+    action(userPrompt: string): Promise<ExecutionResult>;
+    query(demand: InsightExtractParam): Promise<ExecutionResult>;
+    assert(assertion: string): Promise<ExecutionResult<InsightAssertionResponse>>;
+    waitFor(assertion: string, opt: PlanningActionParamWaitFor): Promise<ExecutionResult<void>>;
+}
+
+export { type AiTaskCache as A, PageTaskExecutor as P };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@midscene/web",
   "description": "Web integration for Midscene.js",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "jsnext:source": "./src/index.ts",
   "main": "./dist/lib/index.js",
   "module": "./dist/es/index.js",
@@ -12,11 +12,26 @@
       "import": "./dist/es/index.js",
       "require": "./dist/lib/index.js"
     },
+    "./puppeteer": {
+      "types": "./dist/types/puppeteer.d.ts",
+      "import": "./dist/es/puppeteer.js",
+      "require": "./dist/lib/puppeteer.js"
+    },
+    "./playwright": {
+      "types": "./dist/types/playwright.d.ts",
+      "import": "./dist/es/playwright.js",
+      "require": "./dist/lib/playwright.js"
+    },
     "./playwright-report": {
       "types": "./dist/types/playwright-report.d.ts",
       "import": "./dist/es/playwright-report.js",
       "require": "./dist/lib/playwright-report.js"
     },
+    "./debug": {
+      "types": "./dist/types/debug.d.ts",
+      "import": "./dist/es/debug.js",
+      "require": "./dist/lib/debug.js"
+    },
     "./constants": {
       "types": "./dist/types/constants.d.ts",
       "import": "./dist/es/constants.js",
@@ -33,9 +48,18 @@
       ".": [
         "./dist/types/index.d.ts"
       ],
+      "puppeteer": [
+        "./dist/types/puppeteer.d.ts"
+      ],
+      "playwright": [
+        "./dist/types/playwright.d.ts"
+      ],
       "playwright-report": [
         "./dist/types/playwright-report.d.ts"
       ],
+      "debug": [
+        "./dist/types/debug.d.ts"
+      ],
       "constants": [
         "./dist/types/constants.d.ts"
       ],
@@ -52,7 +76,7 @@
     "openai": "4.47.1",
     "sharp": "0.33.3",
     "inquirer": "10.1.5",
-    "@midscene/core": "0.3.2"
+    "@midscene/core": "0.3.3"
   },
   "devDependencies": {
     "@modern-js/module-tools": "^2.56.1",