@xiuchang-midscene/shared 2.0.2 → 2.0.3

package/dist/lib/utils.js.bak

@@ -1,148 +0,0 @@
-"use strict";
-var __webpack_require__ = {};
-(()=>{
-    __webpack_require__.d = (exports1, definition)=>{
-        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
-            enumerable: true,
-            get: definition[key]
-        });
-    };
-})();
-(()=>{
-    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
-})();
-(()=>{
-    __webpack_require__.r = (exports1)=>{
-        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
-            value: 'Module'
-        });
-        Object.defineProperty(exports1, '__esModule', {
-            value: true
-        });
-    };
-})();
-var __webpack_exports__ = {};
-__webpack_require__.r(__webpack_exports__);
-__webpack_require__.d(__webpack_exports__, {
-    uuid: ()=>uuid,
-    isPlainObject: ()=>isPlainObject,
-    ifInBrowser: ()=>ifInBrowser,
-    repeat: ()=>repeat,
-    mergeAndNormalizeAppNameMapping: ()=>mergeAndNormalizeAppNameMapping,
-    ifInNode: ()=>ifInNode,
-    assert: ()=>assert,
-    escapeScriptTag: ()=>escapeScriptTag,
-    logMsg: ()=>logMsg,
-    replaceIllegalPathCharsAndSpace: ()=>replaceIllegalPathCharsAndSpace,
-    generateHashId: ()=>generateHashId,
-    normalizeForComparison: ()=>normalizeForComparison,
-    ifInWorker: ()=>ifInWorker,
-    setIsMcp: ()=>setIsMcp,
-    antiEscapeScriptTag: ()=>antiEscapeScriptTag
-});
-const external_js_sha256_namespaceObject = require("js-sha256");
-const external_uuid_namespaceObject = require("uuid");
-const ifInBrowser = 'undefined' != typeof window;
-const ifInWorker = 'undefined' != typeof WorkerGlobalScope;
-const ifInNode = 'undefined' != typeof process && process.versions?.node;
-function uuid() {
-    return (0, external_uuid_namespaceObject.v4)();
-}
-const hashMap = {};
-function generateHashId(rect, content = '') {
-    const combined = JSON.stringify({
-        content,
-        rect
-    });
-    let sliceLength = 5;
-    let slicedHash = '';
-    const hashHex = external_js_sha256_namespaceObject.sha256.create().update(combined).hex();
-    const toLetters = (hex)=>hex.split('').map((char)=>{
-            const code = Number.parseInt(char, 16);
-            return String.fromCharCode(97 + code % 26);
-        }).join('');
-    const hashLetters = toLetters(hashHex);
-    while(sliceLength < hashLetters.length - 1){
-        slicedHash = hashLetters.slice(0, sliceLength);
-        if (hashMap[slicedHash] && hashMap[slicedHash] !== combined) {
-            sliceLength++;
-            continue;
-        }
-        hashMap[slicedHash] = combined;
-        break;
-    }
-    return slicedHash;
-}
-function assert(condition, message) {
-    if (!condition) throw new Error(message || 'Assertion failed');
-}
-let isMcp = false;
-function setIsMcp(value) {
-    isMcp = value;
-}
-function logMsg(...message) {
-    if (!isMcp) console.log(...message);
-}
-async function repeat(times, fn) {
-    for(let i = 0; i < times; i++)await fn(i);
-}
-const utils_REGEXP_LT = /</g;
-const utils_REGEXP_GT = />/g;
-const REGEXP_LT_ESCAPE = '__midscene_lt__';
-const REGEXP_GT_ESCAPE = '__midscene_gt__';
-const escapeScriptTag = (html)=>html.replace(utils_REGEXP_LT, REGEXP_LT_ESCAPE).replace(utils_REGEXP_GT, REGEXP_GT_ESCAPE);
-const antiEscapeScriptTag = (html)=>{
-    const REGEXP_LT = new RegExp(REGEXP_LT_ESCAPE, 'g');
-    const REGEXP_GT = new RegExp(REGEXP_GT_ESCAPE, 'g');
-    return html.replace(REGEXP_LT, '<').replace(REGEXP_GT, '>');
-};
-function replaceIllegalPathCharsAndSpace(str) {
-    return str.replace(/[:*?"<>|# ]/g, '-');
-}
-function isPlainObject(value) {
-    return 'object' == typeof value && null !== value && !Array.isArray(value);
-}
-function normalizeForComparison(str) {
-    return str.toLowerCase().replace(/[\s\-_]+/g, '');
-}
-function mergeAndNormalizeAppNameMapping(defaultMapping, userMapping) {
-    const result = {};
-    for (const [key, value] of Object.entries(defaultMapping))result[normalizeForComparison(key)] = value;
-    if (userMapping) for (const [key, value] of Object.entries(userMapping))result[normalizeForComparison(key)] = value;
-    return result;
-}
-exports.antiEscapeScriptTag = __webpack_exports__.antiEscapeScriptTag;
-exports.assert = __webpack_exports__.assert;
-exports.escapeScriptTag = __webpack_exports__.escapeScriptTag;
-exports.generateHashId = __webpack_exports__.generateHashId;
-exports.ifInBrowser = __webpack_exports__.ifInBrowser;
-exports.ifInNode = __webpack_exports__.ifInNode;
-exports.ifInWorker = __webpack_exports__.ifInWorker;
-exports.isPlainObject = __webpack_exports__.isPlainObject;
-exports.logMsg = __webpack_exports__.logMsg;
-exports.mergeAndNormalizeAppNameMapping = __webpack_exports__.mergeAndNormalizeAppNameMapping;
-exports.normalizeForComparison = __webpack_exports__.normalizeForComparison;
-exports.repeat = __webpack_exports__.repeat;
-exports.replaceIllegalPathCharsAndSpace = __webpack_exports__.replaceIllegalPathCharsAndSpace;
-exports.setIsMcp = __webpack_exports__.setIsMcp;
-exports.uuid = __webpack_exports__.uuid;
-for(var __rspack_i in __webpack_exports__)if (-1 === [
-    "antiEscapeScriptTag",
-    "assert",
-    "escapeScriptTag",
-    "generateHashId",
-    "ifInBrowser",
-    "ifInNode",
-    "ifInWorker",
-    "isPlainObject",
-    "logMsg",
-    "mergeAndNormalizeAppNameMapping",
-    "normalizeForComparison",
-    "repeat",
-    "replaceIllegalPathCharsAndSpace",
-    "setIsMcp",
-    "uuid"
-].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
-Object.defineProperty(exports, '__esModule', {
-    value: true
-});

package/dist/lib/zod-schema-utils.js.bak

@@ -1,97 +0,0 @@
-"use strict";
-var __webpack_require__ = {};
-(()=>{
-    __webpack_require__.d = (exports1, definition)=>{
-        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
-            enumerable: true,
-            get: definition[key]
-        });
-    };
-})();
-(()=>{
-    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
-})();
-(()=>{
-    __webpack_require__.r = (exports1)=>{
-        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
-            value: 'Module'
-        });
-        Object.defineProperty(exports1, '__esModule', {
-            value: true
-        });
-    };
-})();
-var __webpack_exports__ = {};
-__webpack_require__.r(__webpack_exports__);
-__webpack_require__.d(__webpack_exports__, {
-    getZodDescription: ()=>getZodDescription,
-    getZodTypeName: ()=>getZodTypeName,
-    isMidsceneLocatorField: ()=>isMidsceneLocatorField,
-    unwrapZodField: ()=>unwrapZodField
-});
-function unwrapZodField(field) {
-    const f = field;
-    if (!f._def) return f;
-    const typeName = f._def.typeName;
-    if ('ZodOptional' === typeName || 'ZodNullable' === typeName || 'ZodDefault' === typeName) return unwrapZodField(f._def.innerType);
-    if ('ZodEffects' === typeName) {
-        if (f._def.schema) return unwrapZodField(f._def.schema);
-    }
-    return f;
-}
-function isMidsceneLocatorField(field) {
-    const actualField = unwrapZodField(field);
-    if (actualField._def?.typeName === 'ZodObject') {
-        const shape = actualField._def.shape?.();
-        if (shape) {
-            if ('midscene_location_field_flag' in shape) return true;
-            if ('prompt' in shape && shape.prompt) return true;
-        }
-    }
-    return false;
-}
-function getZodTypeName(field, locatorTypeDescription) {
-    const actualField = unwrapZodField(field);
-    const fieldTypeName = actualField._def?.typeName;
-    if ('ZodString' === fieldTypeName) return 'string';
-    if ('ZodNumber' === fieldTypeName) return 'number';
-    if ('ZodBoolean' === fieldTypeName) return 'boolean';
-    if ('ZodArray' === fieldTypeName) return 'array';
-    if ('ZodObject' === fieldTypeName) {
-        if (isMidsceneLocatorField(actualField)) return locatorTypeDescription || 'object';
-        return 'object';
-    }
-    if ('ZodEnum' === fieldTypeName) {
-        const values = actualField._def?.values?.map((option)=>String(`'${option}'`)).join(', ') ?? 'enum';
-        return `enum(${values})`;
-    }
-    if ('ZodUnion' === fieldTypeName) {
-        const options = actualField._def?.options;
-        if (options && options.length > 0) {
-            const types = options.map((opt)=>getZodTypeName(opt, locatorTypeDescription));
-            return types.join(' | ');
-        }
-        return 'union';
-    }
-    return 'unknown';
-}
-function getZodDescription(field) {
-    if ("description" in field) return field.description || null;
-    const actualField = unwrapZodField(field);
-    if ("description" in actualField) return actualField.description || null;
-    if (isMidsceneLocatorField(actualField)) return 'Location information for the target element';
-    return null;
-}
-exports.getZodDescription = __webpack_exports__.getZodDescription;
-exports.getZodTypeName = __webpack_exports__.getZodTypeName;
-exports.isMidsceneLocatorField = __webpack_exports__.isMidsceneLocatorField;
-exports.unwrapZodField = __webpack_exports__.unwrapZodField;
-for(var __rspack_i in __webpack_exports__)if (-1 === [
-    "getZodDescription",
-    "getZodTypeName",
-    "isMidsceneLocatorField",
-    "unwrapZodField"
-].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
-Object.defineProperty(exports, '__esModule', {
-    value: true
-});

package/dist/types/baseDB.d.ts.bak

@@ -1,25 +0,0 @@
-export declare class IndexedDBManager {
-    private dbPromise;
-    private dbName;
-    private version;
-    private storeConfigs;
-    constructor(dbName: string, version: number, storeConfigs: Array<{
-        name: string;
-        keyPath: string;
-    }>);
-    private initDB;
-    private withTransaction;
-    private promisifyRequest;
-    put<T>(storeName: string, data: T): Promise<void>;
-    get<T>(storeName: string, key: string): Promise<T | undefined>;
-    getAll<T>(storeName: string, sortByTimestamp?: boolean): Promise<T[]>;
-    clear(storeName: string): Promise<void>;
-    delete(storeName: string, key: string): Promise<void>;
-    count(storeName: string): Promise<number>;
-    getDBPromise(): Promise<IDBDatabase>;
-}
-export declare const withErrorHandling: <T>(operation: () => Promise<T>, errorMessage: string, defaultValue?: T, onQuotaExceeded?: () => Promise<void>) => Promise<T | undefined>;
-export declare const createCleanupFunction: <T extends {
-    id: string;
-    timestamp: number;
-}>(dbManager: IndexedDBManager, storeName: string, maxItems: number) => () => Promise<void>;

package/dist/types/build/copy-static.d.ts.bak

@@ -1,31 +0,0 @@
-export interface CopyStaticOptions {
-    /** Source directory to copy from */
-    srcDir: string;
-    /** Destination directory to copy to */
-    destDir: string;
-    /** Optional favicon source path (relative to directory containing srcDir) */
-    faviconPath?: string;
-    /** Name for the rsbuild plugin */
-    pluginName?: string;
-}
-/**
- * Creates an rsbuild plugin that copies static files after build
- * @param options Configuration options for copying static files
- * @returns Rsbuild plugin object
- */
-export declare const createCopyStaticPlugin: (options: CopyStaticOptions) => {
-    name: string;
-    setup(api: any): void;
-};
-/**
- * Helper function to create a copy static plugin for playground builds
- * @param srcDir Source directory (usually dist directory)
- * @param destDir Destination directory
- * @param pluginName Optional plugin name
- * @param faviconSrc Optional favicon source path
- * @returns Rsbuild plugin
- */
-export declare const createPlaygroundCopyPlugin: (srcDir: string, destDir: string, pluginName?: string, faviconSrc?: string) => {
-    name: string;
-    setup(api: any): void;
-};

package/dist/types/build/rspack-config.d.ts.bak

@@ -1,8 +0,0 @@
-/**
- * Common Rspack configuration helpers for rsbuild projects
- */
-/**
- * Common warning patterns to ignore in Rspack builds.
- * These warnings are typically from optional dependencies or known non-critical issues.
- */
-export declare const commonIgnoreWarnings: RegExp[];

package/dist/types/cli/cli-runner.d.ts.bak

@@ -1,14 +0,0 @@
-import type { BaseMidsceneTools } from '../mcp/base-tools';
-export interface CLIRunnerOptions {
-    stripPrefix?: string;
-    argv?: string[];
-    version?: string;
-}
-export declare class CLIError extends Error {
-    exitCode: number;
-    constructor(message: string, exitCode?: number);
-}
-export declare function parseValue(raw: string): unknown;
-export declare function parseCliArgs(args: string[]): Record<string, unknown>;
-export declare function removePrefix(name: string, prefix?: string): string;
-export declare function runToolsCLI(tools: BaseMidsceneTools, scriptName: string, options?: CLIRunnerOptions): Promise<void>;

package/dist/types/cli/index.d.ts.bak

@@ -1,2 +0,0 @@
-export { runToolsCLI, CLIError, parseValue, parseCliArgs, removePrefix, } from './cli-runner';
-export type { CLIRunnerOptions } from './cli-runner';

package/dist/types/common.d.ts.bak

@@ -1,12 +0,0 @@
-export declare const defaultRunDirName = "midscene_run";
-export declare const getMidsceneRunDir: () => string;
-export declare const getMidsceneRunBaseDir: () => string;
-/**
- * Get the path to the midscene_run directory or a subdirectory within it.
- * Creates the directory if it doesn't exist.
- *
- * @param subdir - Optional subdirectory name (e.g., 'log', 'report')
- * @returns The absolute path to the requested directory
- */
-export declare const getMidsceneRunSubDir: (subdir: "dump" | "cache" | "report" | "tmp" | "log" | "output") => string;
-export declare const ERROR_CODE_NOT_IMPLEMENTED_AS_DESIGNED = "NOT_IMPLEMENTED_AS_DESIGNED";

package/dist/types/constants/example-code.d.ts.bak

@@ -1,2 +0,0 @@
-export declare const PLAYWRIGHT_EXAMPLE_CODE = "\n// Reference the following code to generate Midscene test cases\n// The following is test code for Midscene AI, for reference\n// The following is Playwright syntax, you can use Playwright to assist in test generation\nIMPORTANT: Follow these exact type signatures for AI functions:\n\n// Type signatures for AI functions:\naiAct(prompt: string, options?: { cacheable?: boolean, deepThink?: 'unset' | true | false }): Promise<void>\naiInput(text: string, locate: string, options?: { deepLocate?: boolean, xpath?: string, cacheable?: boolean }): Promise<void>\naiTap(locate: string, options?: { deepLocate?: boolean, xpath?: string, cacheable?: boolean }): Promise<void>\naiHover(locate: string, options?: { deepLocate?: boolean, xpath?: string, cacheable?: boolean }): Promise<void>\naiDoubleClick(locate: string, options?: { deepLocate?: boolean, xpath?: string, cacheable?: boolean }): Promise<void>\naiKeyboardPress(key: string, locate?: string, options?: { deepLocate?: boolean, xpath?: string, cacheable?: boolean }): Promise<void>\naiScroll(locate: string | undefined, options: {\n  direction?: 'up' | 'down' | 'left' | 'right',\n  scrollType?: 'singleAction' | 'scrollToBottom' | 'scrollToTop' | 'scrollToRight' | 'scrollToLeft',\n  distance?: number | null,\n  deepLocate?: boolean,\n  xpath?: string,\n  cacheable?: boolean\n}): Promise<void>\naiAssert(assertion: string, options?: { errorMessage?: string }): Promise<void>\naiWaitFor(prompt: string, options?: { timeout?: number }): Promise<void>\naiQuery<T>(queryObject: Record<string, string>): Promise<T> // Extracts data from page based on descriptions\n\n// examples:\n// Reference the following code to generate Midscene test cases\n// The following is test code for Midscene AI, for reference\n// The following is Playwright syntax, you can use Playwright to assist in test generation\nimport { test as base } from '@playwright/test';\nimport type { PlayWrightAiFixtureType } from '@midscene/web/playwright';\nimport { PlaywrightAiFixture } from '@midscene/web/playwright';\n\nconst test = base.extend<PlayWrightAiFixtureType>(PlaywrightAiFixture({\n  waitForNetworkIdleTimeout: 2000, // optional, the timeout for waiting for network idle between each action, default is 2000ms\n}));\n\n\ntest.beforeEach(async ({ page }) => {\n  await page.goto('https://www.xxx.com/');\n  await page.setViewportSize({ width: 1920, height: 1080 });\n});\n\ntest('ai shop', async ({\n  aiAct,\n  aiInput,\n  aiAssert,\n  aiQuery,\n  aiKeyboardPress,\n  aiHover,\n  aiTap,\n  aiWaitFor,\n  agentForPage,\n  page,\n}) => {\n  // login\n  await aiAssert('The page shows the login interface');\n  await aiInput('user_name', 'in user name input');\n  await aiInput('password', 'in password input');\n  await aiKeyboardPress('Enter', 'Login Button');\n\n  // check the login success\n  await aiWaitFor('The page shows that the loading is complete');\n  await aiAssert('The current page shows the product detail page');\n\n  // check the product info\n  const dataA = await aiQuery({\n    userInfo: 'User information in the format {name: string}',\n    theFirstProductInfo: 'The first product info in the format {name: string, price: number}',\n  });\n  expect(dataA.theFirstProductInfo.name).toBe('xxx');\n  expect(dataA.theFirstProductInfo.price).toBe(100);\n\n\n  // add to cart\n  await aiTap('click add to cart button');\n  \n  await aiTap('click right top cart icon');\n  await aiAssert('The cart icon shows the number 1');\n});\n";
-export declare const YAML_EXAMPLE_CODE = "\n1. Format:\n\nweb:\n  url: \"starting_url\"\n  viewportWidth: 1280\n  viewportHeight: 960\n\ntasks:\n  - name: \"descriptive task name\"\n    flow:\n      - aiTap: \"element description\"\n      - aiInput: 'text value'\n        locate: 'input field description'\n      - aiScroll:\n        direction: down/up\n        scrollType: scrollToBottom/scrollToTop/singleAction\n      - aiAssert: \"expected state\"\n      - sleep: milliseconds\n\n2. Action Types:\n- aiTap: for clicks (natural language targeting)\n- aiInput: for text input with 'locate' field\n- aiScroll: with direction and scrollType\n- aiAssert: for validations\n- sleep: for delays (milliseconds)\n\n3. Best Practices:\n- Group related actions into logical tasks\n- Use natural language descriptions\n- Add deepLocate: true for complex interactions\n- Keep task names concise but descriptive\n\n4. CRITICAL - YAML Indentation Rules:\n- For actions with additional parameters (aiScroll, aiInput, aiKeyboardPress), the parameters must be SIBLING keys, NOT nested children\n- Parameters like direction, scrollType, locate must align with the action key, not indented further\n- CORRECT indentation example:\n      - aiScroll:\n        direction: down\n        scrollType: singleAction\n- WRONG indentation (DO NOT do this):\n      - aiScroll:\n          direction: down\n          scrollType: singleAction\n\n\n\nYAML type\ntasks:\n  - name: <name>\n    continueOnError: <boolean> # Optional, whether to continue to the next task on error, defaults to false.\n    flow:\n      # Auto Planning (.ai)\n      # ----------------\n\n      # Perform an interaction. `ai` is a shorthand for `aiAct`.\n      - ai: <prompt>\n        cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.\n\n      # This usage is the same as `ai`.\n      - aiAct: <prompt>\n        cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.\n\n      # Instant Action (.aiTap, .aiDoubleClick, .aiHover, .aiInput, .aiKeyboardPress, .aiScroll)\n      # ----------------\n\n      # Tap an element described by a prompt.\n      - aiTap: <prompt>\n        deepLocate: <boolean> # Optional, whether to use deepLocate to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Midscene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.\n        cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.\n\n      # Double click an element described by a prompt.\n      - aiDoubleClick: <prompt>\n        deepLocate: <boolean> # Optional, whether to use deepLocate to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Midscene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.\n        cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.\n\n      # Hover over an element described by a prompt.\n      - aiHover: <prompt>\n        deepLocate: <boolean> # Optional, whether to use deepLocate to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Midscene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.\n        cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.\n\n      # Input text into an element described by a prompt.\n      - aiInput: <final text content of the input>\n        locate: <prompt>\n        deepLocate: <boolean> # Optional, whether to use deepLocate to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Midscene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.\n        cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.\n\n      # Press a key (e.g., Enter, Tab, Escape) on an element described by a prompt.\n      - aiKeyboardPress: <key>\n        locate: <prompt>\n        deepLocate: <boolean> # Optional, whether to use deepLocate to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Midscene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.\n        cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.\n\n      # Scroll globally or on an element described by a prompt.\n      - aiScroll:\n        direction: 'up' # or 'down' | 'left' | 'right'\n        scrollType: 'singleAction' # or 'scrollToTop' | 'scrollToBottom' | 'scrollToLeft' | 'scrollToRight'\n        distance: <number> # Optional, the scroll distance in pixels.\n        locate: <prompt> # Optional, the element to scroll on.\n        deepLocate: <boolean> # Optional, whether to use deepLocate to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Midscene will prioritize this xpath to find the element before using the cache and the AI model. Defaults to empty.\n        cacheable: <boolean> # Optional, whether to cache the result of this API call when the [caching feature](./caching.mdx) is enabled. Defaults to True.\n\n      # Record the current screenshot with a description in the report file.\n      - recordToReport: <title> # Optional, the title of the screenshot. If not provided, the title will be 'untitled'.\n        content: <content> # Optional, the description of the screenshot.\n\n      # Data Extraction\n      # ----------------\n\n      # Perform a query that returns a JSON object.\n      - aiQuery: <prompt> # Remember to describe the format of the result in the prompt.\n        name: <name> # The key for the query result in the JSON output.\n\n      # More APIs\n      # ----------------\n\n      # Wait for a condition to be met, with a timeout (in ms, optional, defaults to 30000).\n      - aiWaitFor: <prompt>\n        timeout: <ms>\n\n      # Perform an assertion.\n      - aiAssert: <prompt>\n        errorMessage: <error-message> # Optional, the error message to print if the assertion fails.\n\n      # Wait for a specified amount of time.\n      - sleep: <ms>\n\n      # Execute a piece of JavaScript code in the web page context.\n      - javascript: <javascript>\n        name: <name> # Optional, assign a name to the return value, which will be used as a key in the JSON output.\n\n  - name: <name>\n    flow:\n      # ...\n";

package/dist/types/constants/index.d.ts.bak

@@ -1,21 +0,0 @@
-export declare const TEXT_SIZE_THRESHOLD = 9;
-export declare const TEXT_MAX_SIZE = 40;
-export declare const CONTAINER_MINI_HEIGHT = 3;
-export declare const CONTAINER_MINI_WIDTH = 3;
-export declare enum NodeType {
-    CONTAINER = "CONTAINER Node",
-    FORM_ITEM = "FORM_ITEM Node",
-    BUTTON = "BUTTON Node",
-    A = "Anchor Node",
-    IMG = "IMG Node",
-    TEXT = "TEXT Node",
-    POSITION = "POSITION Node"
-}
-export declare const PLAYGROUND_SERVER_PORT = 5800;
-export declare const SCRCPY_SERVER_PORT = 5700;
-export declare const WEBDRIVER_ELEMENT_ID_KEY = "element-6066-11e4-a52e-4f735466cecf";
-export declare const DEFAULT_WDA_PORT = 8100;
-export declare const DEFAULT_WAIT_FOR_NAVIGATION_TIMEOUT = 5000;
-export declare const DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT = 2000;
-export declare const DEFAULT_WAIT_FOR_NETWORK_IDLE_CONCURRENCY = 2;
-export { PLAYWRIGHT_EXAMPLE_CODE, YAML_EXAMPLE_CODE } from './example-code';

package/dist/types/env/basic.d.ts.bak

@@ -1,6 +0,0 @@
-import { BASIC_ENV_KEYS } from './types';
-/**
- * get basic env value from process.env
- * use a single file to avoid circular dependency
- */
-export declare const getBasicEnvValue: (key: (typeof BASIC_ENV_KEYS)[number]) => string | undefined;

package/dist/types/env/constants.d.ts.bak

@@ -1,40 +0,0 @@
-interface IModelConfigKeys {
-    modelName: string;
-    /**
-     * proxy
-     */
-    socksProxy: string;
-    httpProxy: string;
-    /**
-     * OpenAI
-     */
-    openaiBaseURL: string;
-    openaiApiKey: string;
-    openaiExtraConfig: string;
-    extraBody: string;
-    /**
-     * Extra
-     */
-    modelFamily: string;
-    /**
-     * Timeout
-     */
-    timeout: string;
-    /**
-     * Temperature
-     */
-    temperature: string;
-    /**
-     * Retry
-     */
-    retryCount: string;
-    retryInterval: string;
-    reasoningEffort: string;
-    reasoningEnabled: string;
-    reasoningBudget: string;
-}
-export declare const INSIGHT_MODEL_CONFIG_KEYS: IModelConfigKeys;
-export declare const PLANNING_MODEL_CONFIG_KEYS: IModelConfigKeys;
-export declare const DEFAULT_MODEL_CONFIG_KEYS: IModelConfigKeys;
-export declare const DEFAULT_MODEL_CONFIG_KEYS_LEGACY: IModelConfigKeys;
-export {};

package/dist/types/env/global-config-manager.d.ts.bak

@@ -1,32 +0,0 @@
-import type { ModelConfigManager } from './model-config-manager';
-import { BOOLEAN_ENV_KEYS, GLOBAL_ENV_KEYS, NUMBER_ENV_KEYS, STRING_ENV_KEYS } from './types';
-import { MODEL_ENV_KEYS } from './types';
-/**
- * Collect global configs from process.env, overrideAIConfig, etc.
- * And provider methods to get merged config value
- */
-export declare class GlobalConfigManager {
-    private override;
-    private keysHaveBeenRead;
-    private globalModelConfigManager;
-    constructor();
-    /**
-     * recalculate allEnvConfig every time because process.env can be updated any time
-     */
-    getAllEnvConfig(): Record<string, string | undefined>;
-    getEnvConfigValue(key: (typeof STRING_ENV_KEYS)[number]): string | undefined;
-    /**
-     * read boolean only from process.env
-     */
-    getEnvConfigInBoolean(key: (typeof BOOLEAN_ENV_KEYS)[number]): boolean;
-    /**
-     * Read environment variable value and convert it to number.
-     * Returns undefined if the value is not set or cannot be converted to a valid number.
-     */
-    getEnvConfigValueAsNumber(key: (typeof STRING_ENV_KEYS)[number] | (typeof NUMBER_ENV_KEYS)[number]): number | undefined;
-    registerModelConfigManager(globalModelConfigManager: ModelConfigManager): void;
-    /**
-     * @deprecated use the modelConfig param in Agent constructor instead
-     */
-    overrideAIConfig(newConfig: Partial<Record<(typeof GLOBAL_ENV_KEYS)[number] | (typeof MODEL_ENV_KEYS)[number], string>>, extendMode?: boolean): void;
-}

package/dist/types/env/helper.d.ts.bak

@@ -1,4 +0,0 @@
-export declare const maskConfig: (config: Record<string, unknown>) => {
-    [k: string]: unknown;
-};
-export declare const parseJson: (key: string, value: string | undefined) => any;

package/dist/types/env/index.d.ts.bak

@@ -1,4 +0,0 @@
-export * from './utils';
-export * from './types';
-export { ModelConfigManager } from './model-config-manager';
-export { GlobalConfigManager } from './global-config-manager';

package/dist/types/env/init-debug.d.ts.bak

@@ -1 +0,0 @@
-export declare const initDebugConfig: () => void;

package/dist/types/env/model-config-manager.d.ts.bak

@@ -1,25 +0,0 @@
-import type { GlobalConfigManager } from './global-config-manager';
-import type { CreateOpenAIClientFn, IModelConfig, TIntent, TModelConfig } from './types';
-export declare class ModelConfigManager {
-    private modelConfigMap;
-    private isInitialized;
-    private isolatedMode;
-    private globalConfigManager;
-    private modelConfig?;
-    private createOpenAIClientFn?;
-    constructor(modelConfig?: TModelConfig, createOpenAIClientFn?: CreateOpenAIClientFn);
-    private initialize;
-    private normalizeModelConfig;
-    /**
-     * should only be called by GlobalConfigManager
-     */
-    clearModelConfigMap(): void;
-    /**
-     * if isolatedMode is true, modelConfigMap was initialized in constructor and can't be changed
-     * if isolatedMode is false, modelConfigMap can be changed by process.env so we need to recalculate it when it's undefined
-     */
-    getModelConfig(intent: TIntent): IModelConfig;
-    getUploadTestServerUrl(): string | undefined;
-    registerGlobalConfigManager(globalConfigManager: GlobalConfigManager): void;
-    throwErrorIfNonVLModel(): void;
-}

package/dist/types/env/parse-model-config.d.ts.bak

@@ -1,31 +0,0 @@
-import { DEFAULT_MODEL_CONFIG_KEYS, type DEFAULT_MODEL_CONFIG_KEYS_LEGACY, INSIGHT_MODEL_CONFIG_KEYS, PLANNING_MODEL_CONFIG_KEYS } from './constants';
-import { type IModelConfig, type TIntent, type TModelFamily, UITarsModelVersion } from './types';
-type TModelConfigKeys = typeof INSIGHT_MODEL_CONFIG_KEYS | typeof PLANNING_MODEL_CONFIG_KEYS | typeof DEFAULT_MODEL_CONFIG_KEYS | typeof DEFAULT_MODEL_CONFIG_KEYS_LEGACY;
-/**
- * Get UI-TARS model version from model family
- * @param modelFamily - The model family value
- * @returns UITarsModelVersion if the model family is a UI-TARS variant, undefined otherwise
- */
-export declare const getUITarsModelVersion: (modelFamily?: TModelFamily) => UITarsModelVersion | undefined;
-/**
- * Validate model family value
- * @param modelFamily - The model family value to validate
- * @throws Error if the model family is invalid
- */
-export declare const validateModelFamily: (modelFamily?: TModelFamily) => void;
-/**
- * Convert legacy environment variables to model family
- * @param provider - Environment variable provider (e.g., process.env)
- * @returns The corresponding model family value, or undefined if no legacy config is found
- */
-export declare const legacyConfigToModelFamily: (provider: Record<string, string | undefined>) => TModelFamily | undefined;
-/**
- * Parse OpenAI SDK config
- */
-export declare const parseOpenaiSdkConfig: ({ keys, provider, useLegacyLogic, }: {
-    keys: TModelConfigKeys;
-    provider: Record<string, string | undefined>;
-    useLegacyLogic?: boolean;
-}) => IModelConfig;
-export declare const decideModelConfigFromIntentConfig: (intent: TIntent, configMap: Record<string, string | undefined>) => IModelConfig | undefined;
-export {};