@xiuchang-midscene/shared 2.0.2

package/dist/es/constants/example-code.mjs

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

package/dist/es/constants/example-code.mjs.bak

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

package/dist/es/constants/index.mjs

@@ -0,0 +1,23 @@
+import { PLAYWRIGHT_EXAMPLE_CODE, YAML_EXAMPLE_CODE } from "./example-code.mjs";
+const TEXT_SIZE_THRESHOLD = 9;
+const TEXT_MAX_SIZE = 40;
+const CONTAINER_MINI_HEIGHT = 3;
+const CONTAINER_MINI_WIDTH = 3;
+var constants_NodeType = /*#__PURE__*/ function(NodeType) {
+    NodeType["CONTAINER"] = "CONTAINER Node";
+    NodeType["FORM_ITEM"] = "FORM_ITEM Node";
+    NodeType["BUTTON"] = "BUTTON Node";
+    NodeType["A"] = "Anchor Node";
+    NodeType["IMG"] = "IMG Node";
+    NodeType["TEXT"] = "TEXT Node";
+    NodeType["POSITION"] = "POSITION Node";
+    return NodeType;
+}({});
+const PLAYGROUND_SERVER_PORT = 5800;
+const SCRCPY_SERVER_PORT = 5700;
+const WEBDRIVER_ELEMENT_ID_KEY = 'element-6066-11e4-a52e-4f735466cecf';
+const DEFAULT_WDA_PORT = 8100;
+const DEFAULT_WAIT_FOR_NAVIGATION_TIMEOUT = 5000;
+const DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT = 2000;
+const DEFAULT_WAIT_FOR_NETWORK_IDLE_CONCURRENCY = 2;
+export { CONTAINER_MINI_HEIGHT, CONTAINER_MINI_WIDTH, DEFAULT_WAIT_FOR_NAVIGATION_TIMEOUT, DEFAULT_WAIT_FOR_NETWORK_IDLE_CONCURRENCY, DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT, DEFAULT_WDA_PORT, constants_NodeType as NodeType, PLAYGROUND_SERVER_PORT, PLAYWRIGHT_EXAMPLE_CODE, SCRCPY_SERVER_PORT, TEXT_MAX_SIZE, TEXT_SIZE_THRESHOLD, WEBDRIVER_ELEMENT_ID_KEY, YAML_EXAMPLE_CODE };

package/dist/es/constants/index.mjs.bak

@@ -0,0 +1,23 @@
+import { PLAYWRIGHT_EXAMPLE_CODE, YAML_EXAMPLE_CODE } from "./example-code.mjs";
+const TEXT_SIZE_THRESHOLD = 9;
+const TEXT_MAX_SIZE = 40;
+const CONTAINER_MINI_HEIGHT = 3;
+const CONTAINER_MINI_WIDTH = 3;
+var constants_NodeType = /*#__PURE__*/ function(NodeType) {
+    NodeType["CONTAINER"] = "CONTAINER Node";
+    NodeType["FORM_ITEM"] = "FORM_ITEM Node";
+    NodeType["BUTTON"] = "BUTTON Node";
+    NodeType["A"] = "Anchor Node";
+    NodeType["IMG"] = "IMG Node";
+    NodeType["TEXT"] = "TEXT Node";
+    NodeType["POSITION"] = "POSITION Node";
+    return NodeType;
+}({});
+const PLAYGROUND_SERVER_PORT = 5800;
+const SCRCPY_SERVER_PORT = 5700;
+const WEBDRIVER_ELEMENT_ID_KEY = 'element-6066-11e4-a52e-4f735466cecf';
+const DEFAULT_WDA_PORT = 8100;
+const DEFAULT_WAIT_FOR_NAVIGATION_TIMEOUT = 5000;
+const DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT = 2000;
+const DEFAULT_WAIT_FOR_NETWORK_IDLE_CONCURRENCY = 2;
+export { CONTAINER_MINI_HEIGHT, CONTAINER_MINI_WIDTH, DEFAULT_WAIT_FOR_NAVIGATION_TIMEOUT, DEFAULT_WAIT_FOR_NETWORK_IDLE_CONCURRENCY, DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT, DEFAULT_WDA_PORT, constants_NodeType as NodeType, PLAYGROUND_SERVER_PORT, PLAYWRIGHT_EXAMPLE_CODE, SCRCPY_SERVER_PORT, TEXT_MAX_SIZE, TEXT_SIZE_THRESHOLD, WEBDRIVER_ELEMENT_ID_KEY, YAML_EXAMPLE_CODE };

package/dist/es/env/basic.mjs

@@ -0,0 +1,6 @@
+import { BASIC_ENV_KEYS } from "./types.mjs";
+const getBasicEnvValue = (key)=>{
+    if (!BASIC_ENV_KEYS.includes(key)) throw new Error(`getBasicEnvValue with key ${key} is not supported.`);
+    return process.env[key];
+};
+export { getBasicEnvValue };

package/dist/es/env/basic.mjs.bak

@@ -0,0 +1,6 @@
+import { BASIC_ENV_KEYS } from "./types.mjs";
+const getBasicEnvValue = (key)=>{
+    if (!BASIC_ENV_KEYS.includes(key)) throw new Error(`getBasicEnvValue with key ${key} is not supported.`);
+    return process.env[key];
+};
+export { getBasicEnvValue };

package/dist/es/env/constants.mjs

@@ -0,0 +1,70 @@
+import { MIDSCENE_INSIGHT_MODEL_API_KEY, MIDSCENE_INSIGHT_MODEL_BASE_URL, MIDSCENE_INSIGHT_MODEL_EXTRA_BODY_JSON, MIDSCENE_INSIGHT_MODEL_FAMILY, MIDSCENE_INSIGHT_MODEL_HTTP_PROXY, MIDSCENE_INSIGHT_MODEL_INIT_CONFIG_JSON, MIDSCENE_INSIGHT_MODEL_NAME, MIDSCENE_INSIGHT_MODEL_REASONING_BUDGET, MIDSCENE_INSIGHT_MODEL_REASONING_EFFORT, MIDSCENE_INSIGHT_MODEL_REASONING_ENABLED, MIDSCENE_INSIGHT_MODEL_RETRY_COUNT, MIDSCENE_INSIGHT_MODEL_RETRY_INTERVAL, MIDSCENE_INSIGHT_MODEL_SOCKS_PROXY, MIDSCENE_INSIGHT_MODEL_TEMPERATURE, MIDSCENE_INSIGHT_MODEL_TIMEOUT, MIDSCENE_MODEL_API_KEY, MIDSCENE_MODEL_BASE_URL, MIDSCENE_MODEL_EXTRA_BODY_JSON, MIDSCENE_MODEL_FAMILY, MIDSCENE_MODEL_HTTP_PROXY, MIDSCENE_MODEL_INIT_CONFIG_JSON, MIDSCENE_MODEL_NAME, MIDSCENE_MODEL_REASONING_BUDGET, MIDSCENE_MODEL_REASONING_EFFORT, MIDSCENE_MODEL_REASONING_ENABLED, MIDSCENE_MODEL_RETRY_COUNT, MIDSCENE_MODEL_RETRY_INTERVAL, MIDSCENE_MODEL_SOCKS_PROXY, MIDSCENE_MODEL_TEMPERATURE, MIDSCENE_MODEL_TIMEOUT, MIDSCENE_OPENAI_HTTP_PROXY, MIDSCENE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_OPENAI_SOCKS_PROXY, MIDSCENE_PLANNING_MODEL_API_KEY, MIDSCENE_PLANNING_MODEL_BASE_URL, MIDSCENE_PLANNING_MODEL_EXTRA_BODY_JSON, MIDSCENE_PLANNING_MODEL_FAMILY, MIDSCENE_PLANNING_MODEL_HTTP_PROXY, MIDSCENE_PLANNING_MODEL_INIT_CONFIG_JSON, MIDSCENE_PLANNING_MODEL_NAME, MIDSCENE_PLANNING_MODEL_REASONING_BUDGET, MIDSCENE_PLANNING_MODEL_REASONING_EFFORT, MIDSCENE_PLANNING_MODEL_REASONING_ENABLED, MIDSCENE_PLANNING_MODEL_RETRY_COUNT, MIDSCENE_PLANNING_MODEL_RETRY_INTERVAL, MIDSCENE_PLANNING_MODEL_SOCKS_PROXY, MIDSCENE_PLANNING_MODEL_TEMPERATURE, MIDSCENE_PLANNING_MODEL_TIMEOUT, OPENAI_API_KEY, OPENAI_BASE_URL } from "./types.mjs";
+const INSIGHT_MODEL_CONFIG_KEYS = {
+    modelName: MIDSCENE_INSIGHT_MODEL_NAME,
+    socksProxy: MIDSCENE_INSIGHT_MODEL_SOCKS_PROXY,
+    httpProxy: MIDSCENE_INSIGHT_MODEL_HTTP_PROXY,
+    openaiBaseURL: MIDSCENE_INSIGHT_MODEL_BASE_URL,
+    openaiApiKey: MIDSCENE_INSIGHT_MODEL_API_KEY,
+    openaiExtraConfig: MIDSCENE_INSIGHT_MODEL_INIT_CONFIG_JSON,
+    extraBody: MIDSCENE_INSIGHT_MODEL_EXTRA_BODY_JSON,
+    modelFamily: MIDSCENE_INSIGHT_MODEL_FAMILY,
+    timeout: MIDSCENE_INSIGHT_MODEL_TIMEOUT,
+    temperature: MIDSCENE_INSIGHT_MODEL_TEMPERATURE,
+    retryCount: MIDSCENE_INSIGHT_MODEL_RETRY_COUNT,
+    retryInterval: MIDSCENE_INSIGHT_MODEL_RETRY_INTERVAL,
+    reasoningEffort: MIDSCENE_INSIGHT_MODEL_REASONING_EFFORT,
+    reasoningEnabled: MIDSCENE_INSIGHT_MODEL_REASONING_ENABLED,
+    reasoningBudget: MIDSCENE_INSIGHT_MODEL_REASONING_BUDGET
+};
+const PLANNING_MODEL_CONFIG_KEYS = {
+    modelName: MIDSCENE_PLANNING_MODEL_NAME,
+    socksProxy: MIDSCENE_PLANNING_MODEL_SOCKS_PROXY,
+    httpProxy: MIDSCENE_PLANNING_MODEL_HTTP_PROXY,
+    openaiBaseURL: MIDSCENE_PLANNING_MODEL_BASE_URL,
+    openaiApiKey: MIDSCENE_PLANNING_MODEL_API_KEY,
+    openaiExtraConfig: MIDSCENE_PLANNING_MODEL_INIT_CONFIG_JSON,
+    extraBody: MIDSCENE_PLANNING_MODEL_EXTRA_BODY_JSON,
+    modelFamily: MIDSCENE_PLANNING_MODEL_FAMILY,
+    timeout: MIDSCENE_PLANNING_MODEL_TIMEOUT,
+    temperature: MIDSCENE_PLANNING_MODEL_TEMPERATURE,
+    retryCount: MIDSCENE_PLANNING_MODEL_RETRY_COUNT,
+    retryInterval: MIDSCENE_PLANNING_MODEL_RETRY_INTERVAL,
+    reasoningEffort: MIDSCENE_PLANNING_MODEL_REASONING_EFFORT,
+    reasoningEnabled: MIDSCENE_PLANNING_MODEL_REASONING_ENABLED,
+    reasoningBudget: MIDSCENE_PLANNING_MODEL_REASONING_BUDGET
+};
+const DEFAULT_MODEL_CONFIG_KEYS = {
+    modelName: MIDSCENE_MODEL_NAME,
+    socksProxy: MIDSCENE_MODEL_SOCKS_PROXY,
+    httpProxy: MIDSCENE_MODEL_HTTP_PROXY,
+    openaiBaseURL: MIDSCENE_MODEL_BASE_URL,
+    openaiApiKey: MIDSCENE_MODEL_API_KEY,
+    openaiExtraConfig: MIDSCENE_MODEL_INIT_CONFIG_JSON,
+    extraBody: MIDSCENE_MODEL_EXTRA_BODY_JSON,
+    modelFamily: MIDSCENE_MODEL_FAMILY,
+    timeout: MIDSCENE_MODEL_TIMEOUT,
+    temperature: MIDSCENE_MODEL_TEMPERATURE,
+    retryCount: MIDSCENE_MODEL_RETRY_COUNT,
+    retryInterval: MIDSCENE_MODEL_RETRY_INTERVAL,
+    reasoningEffort: MIDSCENE_MODEL_REASONING_EFFORT,
+    reasoningEnabled: MIDSCENE_MODEL_REASONING_ENABLED,
+    reasoningBudget: MIDSCENE_MODEL_REASONING_BUDGET
+};
+const DEFAULT_MODEL_CONFIG_KEYS_LEGACY = {
+    modelName: MIDSCENE_MODEL_NAME,
+    socksProxy: MIDSCENE_OPENAI_SOCKS_PROXY,
+    httpProxy: MIDSCENE_OPENAI_HTTP_PROXY,
+    openaiBaseURL: OPENAI_BASE_URL,
+    openaiApiKey: OPENAI_API_KEY,
+    openaiExtraConfig: MIDSCENE_OPENAI_INIT_CONFIG_JSON,
+    extraBody: MIDSCENE_MODEL_EXTRA_BODY_JSON,
+    modelFamily: 'DEFAULT_MODEL_CONFIG_KEYS has no modelFamily key',
+    timeout: MIDSCENE_MODEL_TIMEOUT,
+    temperature: MIDSCENE_MODEL_TEMPERATURE,
+    retryCount: MIDSCENE_MODEL_RETRY_COUNT,
+    retryInterval: MIDSCENE_MODEL_RETRY_INTERVAL,
+    reasoningEffort: MIDSCENE_MODEL_REASONING_EFFORT,
+    reasoningEnabled: MIDSCENE_MODEL_REASONING_ENABLED,
+    reasoningBudget: MIDSCENE_MODEL_REASONING_BUDGET
+};
+export { DEFAULT_MODEL_CONFIG_KEYS, DEFAULT_MODEL_CONFIG_KEYS_LEGACY, INSIGHT_MODEL_CONFIG_KEYS, PLANNING_MODEL_CONFIG_KEYS };

package/dist/es/env/constants.mjs.bak

@@ -0,0 +1,70 @@
+import { MIDSCENE_INSIGHT_MODEL_API_KEY, MIDSCENE_INSIGHT_MODEL_BASE_URL, MIDSCENE_INSIGHT_MODEL_EXTRA_BODY_JSON, MIDSCENE_INSIGHT_MODEL_FAMILY, MIDSCENE_INSIGHT_MODEL_HTTP_PROXY, MIDSCENE_INSIGHT_MODEL_INIT_CONFIG_JSON, MIDSCENE_INSIGHT_MODEL_NAME, MIDSCENE_INSIGHT_MODEL_REASONING_BUDGET, MIDSCENE_INSIGHT_MODEL_REASONING_EFFORT, MIDSCENE_INSIGHT_MODEL_REASONING_ENABLED, MIDSCENE_INSIGHT_MODEL_RETRY_COUNT, MIDSCENE_INSIGHT_MODEL_RETRY_INTERVAL, MIDSCENE_INSIGHT_MODEL_SOCKS_PROXY, MIDSCENE_INSIGHT_MODEL_TEMPERATURE, MIDSCENE_INSIGHT_MODEL_TIMEOUT, MIDSCENE_MODEL_API_KEY, MIDSCENE_MODEL_BASE_URL, MIDSCENE_MODEL_EXTRA_BODY_JSON, MIDSCENE_MODEL_FAMILY, MIDSCENE_MODEL_HTTP_PROXY, MIDSCENE_MODEL_INIT_CONFIG_JSON, MIDSCENE_MODEL_NAME, MIDSCENE_MODEL_REASONING_BUDGET, MIDSCENE_MODEL_REASONING_EFFORT, MIDSCENE_MODEL_REASONING_ENABLED, MIDSCENE_MODEL_RETRY_COUNT, MIDSCENE_MODEL_RETRY_INTERVAL, MIDSCENE_MODEL_SOCKS_PROXY, MIDSCENE_MODEL_TEMPERATURE, MIDSCENE_MODEL_TIMEOUT, MIDSCENE_OPENAI_HTTP_PROXY, MIDSCENE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_OPENAI_SOCKS_PROXY, MIDSCENE_PLANNING_MODEL_API_KEY, MIDSCENE_PLANNING_MODEL_BASE_URL, MIDSCENE_PLANNING_MODEL_EXTRA_BODY_JSON, MIDSCENE_PLANNING_MODEL_FAMILY, MIDSCENE_PLANNING_MODEL_HTTP_PROXY, MIDSCENE_PLANNING_MODEL_INIT_CONFIG_JSON, MIDSCENE_PLANNING_MODEL_NAME, MIDSCENE_PLANNING_MODEL_REASONING_BUDGET, MIDSCENE_PLANNING_MODEL_REASONING_EFFORT, MIDSCENE_PLANNING_MODEL_REASONING_ENABLED, MIDSCENE_PLANNING_MODEL_RETRY_COUNT, MIDSCENE_PLANNING_MODEL_RETRY_INTERVAL, MIDSCENE_PLANNING_MODEL_SOCKS_PROXY, MIDSCENE_PLANNING_MODEL_TEMPERATURE, MIDSCENE_PLANNING_MODEL_TIMEOUT, OPENAI_API_KEY, OPENAI_BASE_URL } from "./types.mjs";
+const INSIGHT_MODEL_CONFIG_KEYS = {
+    modelName: MIDSCENE_INSIGHT_MODEL_NAME,
+    socksProxy: MIDSCENE_INSIGHT_MODEL_SOCKS_PROXY,
+    httpProxy: MIDSCENE_INSIGHT_MODEL_HTTP_PROXY,
+    openaiBaseURL: MIDSCENE_INSIGHT_MODEL_BASE_URL,
+    openaiApiKey: MIDSCENE_INSIGHT_MODEL_API_KEY,
+    openaiExtraConfig: MIDSCENE_INSIGHT_MODEL_INIT_CONFIG_JSON,
+    extraBody: MIDSCENE_INSIGHT_MODEL_EXTRA_BODY_JSON,
+    modelFamily: MIDSCENE_INSIGHT_MODEL_FAMILY,
+    timeout: MIDSCENE_INSIGHT_MODEL_TIMEOUT,
+    temperature: MIDSCENE_INSIGHT_MODEL_TEMPERATURE,
+    retryCount: MIDSCENE_INSIGHT_MODEL_RETRY_COUNT,
+    retryInterval: MIDSCENE_INSIGHT_MODEL_RETRY_INTERVAL,
+    reasoningEffort: MIDSCENE_INSIGHT_MODEL_REASONING_EFFORT,
+    reasoningEnabled: MIDSCENE_INSIGHT_MODEL_REASONING_ENABLED,
+    reasoningBudget: MIDSCENE_INSIGHT_MODEL_REASONING_BUDGET
+};
+const PLANNING_MODEL_CONFIG_KEYS = {
+    modelName: MIDSCENE_PLANNING_MODEL_NAME,
+    socksProxy: MIDSCENE_PLANNING_MODEL_SOCKS_PROXY,
+    httpProxy: MIDSCENE_PLANNING_MODEL_HTTP_PROXY,
+    openaiBaseURL: MIDSCENE_PLANNING_MODEL_BASE_URL,
+    openaiApiKey: MIDSCENE_PLANNING_MODEL_API_KEY,
+    openaiExtraConfig: MIDSCENE_PLANNING_MODEL_INIT_CONFIG_JSON,
+    extraBody: MIDSCENE_PLANNING_MODEL_EXTRA_BODY_JSON,
+    modelFamily: MIDSCENE_PLANNING_MODEL_FAMILY,
+    timeout: MIDSCENE_PLANNING_MODEL_TIMEOUT,
+    temperature: MIDSCENE_PLANNING_MODEL_TEMPERATURE,
+    retryCount: MIDSCENE_PLANNING_MODEL_RETRY_COUNT,
+    retryInterval: MIDSCENE_PLANNING_MODEL_RETRY_INTERVAL,
+    reasoningEffort: MIDSCENE_PLANNING_MODEL_REASONING_EFFORT,
+    reasoningEnabled: MIDSCENE_PLANNING_MODEL_REASONING_ENABLED,
+    reasoningBudget: MIDSCENE_PLANNING_MODEL_REASONING_BUDGET
+};
+const DEFAULT_MODEL_CONFIG_KEYS = {
+    modelName: MIDSCENE_MODEL_NAME,
+    socksProxy: MIDSCENE_MODEL_SOCKS_PROXY,
+    httpProxy: MIDSCENE_MODEL_HTTP_PROXY,
+    openaiBaseURL: MIDSCENE_MODEL_BASE_URL,
+    openaiApiKey: MIDSCENE_MODEL_API_KEY,
+    openaiExtraConfig: MIDSCENE_MODEL_INIT_CONFIG_JSON,
+    extraBody: MIDSCENE_MODEL_EXTRA_BODY_JSON,
+    modelFamily: MIDSCENE_MODEL_FAMILY,
+    timeout: MIDSCENE_MODEL_TIMEOUT,
+    temperature: MIDSCENE_MODEL_TEMPERATURE,
+    retryCount: MIDSCENE_MODEL_RETRY_COUNT,
+    retryInterval: MIDSCENE_MODEL_RETRY_INTERVAL,
+    reasoningEffort: MIDSCENE_MODEL_REASONING_EFFORT,
+    reasoningEnabled: MIDSCENE_MODEL_REASONING_ENABLED,
+    reasoningBudget: MIDSCENE_MODEL_REASONING_BUDGET
+};
+const DEFAULT_MODEL_CONFIG_KEYS_LEGACY = {
+    modelName: MIDSCENE_MODEL_NAME,
+    socksProxy: MIDSCENE_OPENAI_SOCKS_PROXY,
+    httpProxy: MIDSCENE_OPENAI_HTTP_PROXY,
+    openaiBaseURL: OPENAI_BASE_URL,
+    openaiApiKey: OPENAI_API_KEY,
+    openaiExtraConfig: MIDSCENE_OPENAI_INIT_CONFIG_JSON,
+    extraBody: MIDSCENE_MODEL_EXTRA_BODY_JSON,
+    modelFamily: 'DEFAULT_MODEL_CONFIG_KEYS has no modelFamily key',
+    timeout: MIDSCENE_MODEL_TIMEOUT,
+    temperature: MIDSCENE_MODEL_TEMPERATURE,
+    retryCount: MIDSCENE_MODEL_RETRY_COUNT,
+    retryInterval: MIDSCENE_MODEL_RETRY_INTERVAL,
+    reasoningEffort: MIDSCENE_MODEL_REASONING_EFFORT,
+    reasoningEnabled: MIDSCENE_MODEL_REASONING_ENABLED,
+    reasoningBudget: MIDSCENE_MODEL_REASONING_BUDGET
+};
+export { DEFAULT_MODEL_CONFIG_KEYS, DEFAULT_MODEL_CONFIG_KEYS_LEGACY, INSIGHT_MODEL_CONFIG_KEYS, PLANNING_MODEL_CONFIG_KEYS };