@rpascene/shared 0.30.9 → 0.30.11

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

@@ -1,2 +1,2 @@
-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:\naiInput(value: string, locator: string): Promise<void>\naiTap(locator: string): Promise<void>\naiDoubleClick(locator: string): Promise<void>\naiScroll(scrollParam: {\n  direction: 'up' | 'down' | 'left' | 'right',\n  scrollType: 'once' | 'untilBottom' | 'untilTop' | 'untilRight' | 'untilLeft',\n  distance: number - scroll distance, px is the unit\n}): Promise<void>\naiAssert(assertion: string): 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 '@rpascene/web/playwright';\nimport { PlaywrightAiFixture } from '@rpascene/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  aiInput,\n  aiAssert,\n  aiQuery,\n  aiKeyboardPress,\n  aiHover,\n  aiTap,\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: untilBottom/untilTop/page\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 deepThink: true for complex interactions\n- Keep task names concise but descriptive\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 `aiAction`.\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      - aiAction: <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        deepThink: <boolean> # Optional, whether to use deepThink 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        deepThink: <boolean> # Optional, whether to use deepThink 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        deepThink: <boolean> # Optional, whether to use deepThink 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        deepThink: <boolean> # Optional, whether to use deepThink 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        deepThink: <boolean> # Optional, whether to use deepThink 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: 'once' # or 'untilTop' | 'untilBottom' | 'untilLeft' | 'untilRight'\n        distance: <number> # Optional, the scroll distance in pixels.\n        locate: <prompt> # Optional, the element to scroll on.\n        deepThink: <boolean> # Optional, whether to use deepThink 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      # Log the current screenshot with a description in the report file.\n      - logScreenshot: <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";
+export declare const PLAYWRIGHT_EXAMPLE_CODE = "\n// Reference the following code to generate Rpascene test cases\n// The following is test code for Rpascene 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:\naiInput(value: string, locator: string): Promise<void>\naiTap(locator: string): Promise<void>\naiDoubleClick(locator: string): Promise<void>\naiScroll(scrollParam: {\n  direction: 'up' | 'down' | 'left' | 'right',\n  scrollType: 'once' | 'untilBottom' | 'untilTop' | 'untilRight' | 'untilLeft',\n  distance: number - scroll distance, px is the unit\n}): Promise<void>\naiAssert(assertion: string): 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 Rpascene test cases\n// The following is test code for Rpascene 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 '@rpascene/web/playwright';\nimport { PlaywrightAiFixture } from '@rpascene/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  aiInput,\n  aiAssert,\n  aiQuery,\n  aiKeyboardPress,\n  aiHover,\n  aiTap,\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: untilBottom/untilTop/page\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 deepThink: true for complex interactions\n- Keep task names concise but descriptive\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 `aiAction`.\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      - aiAction: <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        deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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        deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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        deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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        deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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        deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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: 'once' # or 'untilTop' | 'untilBottom' | 'untilLeft' | 'untilRight'\n        distance: <number> # Optional, the scroll distance in pixels.\n        locate: <prompt> # Optional, the element to scroll on.\n        deepThink: <boolean> # Optional, whether to use deepThink to precisely locate the element. Defaults to False.\n        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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      # Log the current screenshot with a description in the report file.\n      - logScreenshot: <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/env/types.d.ts

@@ -118,7 +118,7 @@ export declare const BOOLEAN_ENV_KEYS: readonly ["MIDSCENE_CACHE", "MIDSCENE_LAN
 export declare const NUMBER_ENV_KEYS: readonly ["MIDSCENE_CACHE_MAX_FILENAME_LENGTH", "MIDSCENE_REPLANNING_CYCLE_LIMIT"];
 export declare const STRING_ENV_KEYS: readonly ["OPENAI_MAX_TOKENS", "MIDSCENE_ADB_PATH", "MIDSCENE_ADB_REMOTE_HOST", "MIDSCENE_ADB_REMOTE_PORT", "MIDSCENE_ANDROID_IME_STRATEGY", "MIDSCENE_IOS_DEVICE_UDID", "MIDSCENE_IOS_SIMULATOR_UDID", "MIDSCENE_REPORT_TAG_NAME", "MIDSCENE_PREFERRED_LANGUAGE", "MATCH_BY_POSITION", "MIDSCENE_MCP_CHROME_PATH", "DOCKER_CONTAINER"];
 /**
- * Non model related env keys, used for globally controlling the behavior of midscene
+ * Non model related env keys, used for globally controlling the behavior of rpascene
  * Can not be override by agent.modelConfig but can be override by overrideAIConfig
  * Can be access at any time
  */

package/dist/types/extractor/util.d.ts

@@ -32,12 +32,12 @@ export declare function elementRect(el: globalThis.HTMLElement | globalThis.Node
 } | false;
 export declare function validTextNodeContent(node: globalThis.Node): string | false;
 export declare function getNodeAttributes(node: globalThis.HTMLElement | globalThis.Node, currentWindow: typeof globalThis.window): Record<string, string>;
-export declare function midsceneGenerateHash(node: globalThis.Node | null, content: string, rect: Rect): string;
+export declare function rpasceneGenerateHash(node: globalThis.Node | null, content: string, rect: Rect): string;
 export declare function setNodeHashCacheListOnWindow(): void;
 export declare function setNodeToCacheList(node: globalThis.Node, id: string): void;
 export declare function getNodeFromCacheList(id: string): any;
 export declare function generateId(numberId: number): string;
 export declare function setGenerateHashOnWindow(): void;
-export declare function setMidsceneVisibleRectOnWindow(): void;
+export declare function setRpasceneVisibleRectOnWindow(): void;
 export declare function setExtractTextWithPositionOnWindow(): void;
 export declare function getTopDocument(): globalThis.HTMLElement;

package/dist/types/node/fs.d.ts

@@ -11,5 +11,5 @@ export declare function getRunningPkgInfo(dir?: string): PkgInfo | null;
  */
 export declare function findNearestPackageJson(dir: string): string | null;
 export declare function getElementInfosScriptContent(): string;
-export declare function getExtraReturnLogic(tree?: boolean): Promise<";midscene_element_inspector.setNodeHashCacheListOnWindow();;midscene_element_inspector.webExtractNodeTree()" | ";midscene_element_inspector.setNodeHashCacheListOnWindow();;midscene_element_inspector.webExtractTextWithPosition()" | null>;
+export declare function getExtraReturnLogic(tree?: boolean): Promise<";rpascene_element_inspector.setNodeHashCacheListOnWindow();;rpascene_element_inspector.webExtractNodeTree()" | ";rpascene_element_inspector.setNodeHashCacheListOnWindow();;rpascene_element_inspector.webExtractTextWithPosition()" | null>;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rpascene/shared",
   "description": "RPA shared",
-  "version": "0.30.9",
+  "version": "0.30.11",
   "repository": "",
   "homepage": "",
   "types": "./dist/types/index.d.ts",
@@ -69,16 +69,6 @@
     "src",
     "README.md"
   ],
-  "scripts": {
-    "dev": "npm run build:watch",
-    "build": "npm run build:script && npm run build:pkg",
-    "build:pkg": "rslib build",
-    "build:script": "rslib build -c ./rslib.inspect.config.ts",
-    "build:watch": "npm run build:script && rslib build --watch",
-    "reset": "rimraf ./**/node_modules",
-    "test": "vitest --run",
-    "test:u": "vitest --run -u"
-  },
   "dependencies": {
     "@silvia-odwyer/photon": "0.3.3",
     "@silvia-odwyer/photon-node": "0.3.3",
@@ -103,5 +93,15 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "scripts": {
+    "dev": "npm run build:watch",
+    "build": "npm run build:script && npm run build:pkg",
+    "build:pkg": "rslib build",
+    "build:script": "rslib build -c ./rslib.inspect.config.ts",
+    "build:watch": "npm run build:script && rslib build --watch",
+    "reset": "rimraf ./**/node_modules",
+    "test": "vitest --run",
+    "test:u": "vitest --run -u"
+  }
 }

package/src/common.ts

@@ -7,10 +7,10 @@ import { getBasicEnvValue } from './env/basic';
 import { MIDSCENE_RUN_DIR } from './env/types';
 import { ifInNode } from './utils';
 
-export const defaultRunDirName = 'midscene_run';
+export const defaultRunDirName = 'rpascene_run';
 // Define locally for now to avoid import issues
 
-export const getMidsceneRunDir = () => {
+export const getRpasceneRunDir = () => {
   if (!ifInNode) {
     return '';
   }
@@ -18,12 +18,12 @@ export const getMidsceneRunDir = () => {
   return getBasicEnvValue(MIDSCENE_RUN_DIR) || defaultRunDirName;
 };
 
-export const getMidsceneRunBaseDir = () => {
+export const getRpasceneRunBaseDir = () => {
   if (!ifInNode) {
     return '';
   }
 
-  let basePath = path.resolve(process.cwd(), getMidsceneRunDir());
+  let basePath = path.resolve(process.cwd(), getRpasceneRunDir());
 
   // Create a base directory
   if (!existsSync(basePath)) {
@@ -40,13 +40,13 @@ export const getMidsceneRunBaseDir = () => {
 };
 
 /**
- * Get the path to the midscene_run directory or a subdirectory within it.
+ * Get the path to the rpascene_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 const getMidsceneRunSubDir = (
+export const getRpasceneRunSubDir = (
   subdir: 'dump' | 'cache' | 'report' | 'tmp' | 'log' | 'output',
 ): string => {
   if (!ifInNode) {
@@ -54,7 +54,7 @@ export const getMidsceneRunSubDir = (
   }
 
   // Create a log directory
-  const basePath = getMidsceneRunBaseDir();
+  const basePath = getRpasceneRunBaseDir();
   const logPath = path.join(basePath, subdir);
   if (!existsSync(logPath)) {
     mkdirSync(logPath, { recursive: true });

package/src/constants/example-code.ts

@@ -1,6 +1,6 @@
 export const PLAYWRIGHT_EXAMPLE_CODE = `
-// Reference the following code to generate Midscene test cases
-// The following is test code for Midscene AI, for reference
+// Reference the following code to generate Rpascene test cases
+// The following is test code for Rpascene 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:
 
@@ -17,8 +17,8 @@ aiAssert(assertion: string): 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
+// Reference the following code to generate Rpascene test cases
+// The following is test code for Rpascene 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 '@rpascene/web/playwright';
@@ -128,33 +128,33 @@ tasks:
       # Tap an element described by a prompt.
       - aiTap: <prompt>
         deepThink: <boolean> # Optional, whether to use deepThink 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.
+        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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>
         deepThink: <boolean> # Optional, whether to use deepThink 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.
+        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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>
         deepThink: <boolean> # Optional, whether to use deepThink 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.
+        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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>
         deepThink: <boolean> # Optional, whether to use deepThink 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.
+        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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>
         deepThink: <boolean> # Optional, whether to use deepThink 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.
+        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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.
@@ -164,7 +164,7 @@ tasks:
         distance: <number> # Optional, the scroll distance in pixels.
         locate: <prompt> # Optional, the element to scroll on.
         deepThink: <boolean> # Optional, whether to use deepThink 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.
+        xpath: <xpath> # Optional, the xpath of the target element for the operation. If provided, Rpascene 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.
 
       # Log the current screenshot with a description in the report file.

package/src/env/init-debug.ts

@@ -7,7 +7,7 @@ export const initDebugConfig = () => {
   let debugConfig = '';
   if (shouldPrintTiming) {
     console.warn(
-      'MIDSCENE_DEBUG_AI_PROFILE is deprecated, use DEBUG=midscene:ai:profile instead',
+      'MIDSCENE_DEBUG_AI_PROFILE is deprecated, use DEBUG=rpascene:ai:profile instead',
     );
     debugConfig = 'ai:profile';
   }
@@ -15,7 +15,7 @@ export const initDebugConfig = () => {
 
   if (shouldPrintAIResponse) {
     console.warn(
-      'MIDSCENE_DEBUG_AI_RESPONSE is deprecated, use DEBUG=midscene:ai:response instead',
+      'MIDSCENE_DEBUG_AI_RESPONSE is deprecated, use DEBUG=rpascene:ai:response instead',
     );
     if (debugConfig) {
       debugConfig = 'ai:*';

package/src/env/model-config-manager.ts

@@ -138,7 +138,7 @@ export class ModelConfigManager {
 
     if (!modelConfig.vlMode) {
       throw new Error(
-        'No visual language model (VL model) detected for the current scenario. Element localization may be inaccurate. Please verify your model configuration. Learn more: https://midscenejs.com/choose-a-model',
+        'No visual language model (VL model) detected for the current scenario. Element localization may be inaccurate. Please verify your model configuration. Learn more: https://rpascenejs.com/choose-a-model',
       );
     }
   }

package/src/env/types.ts

@@ -218,7 +218,7 @@ export const STRING_ENV_KEYS = [
 ] as const;
 
 /**
- * Non model related env keys, used for globally controlling the behavior of midscene
+ * Non model related env keys, used for globally controlling the behavior of rpascene
  * Can not be override by agent.modelConfig but can be override by overrideAIConfig
  * Can be access at any time
  */

package/src/extractor/debug.ts

@@ -1,10 +1,10 @@
 import { webExtractTextWithPosition } from '.';
 import {
   setExtractTextWithPositionOnWindow,
-  setMidsceneVisibleRectOnWindow,
+  setRpasceneVisibleRectOnWindow,
 } from './util';
 
 console.log(webExtractTextWithPosition(document.body, true));
 console.log(JSON.stringify(webExtractTextWithPosition(document.body, true)));
 setExtractTextWithPositionOnWindow();
-setMidsceneVisibleRectOnWindow();
+setRpasceneVisibleRectOnWindow();

package/src/extractor/util.ts

@@ -225,13 +225,13 @@ export function elementRect(
   baseZoom = 1,
 ):
   | {
-      left: number;
-      top: number;
-      width: number;
-      height: number;
-      zoom: number;
-      isVisible: boolean;
-    }
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    zoom: number;
+    isVisible: boolean;
+  }
   | false {
   if (!el) {
     logger(el, 'Element is not in the DOM hierarchy');
@@ -392,7 +392,7 @@ export function getNodeAttributes(
   return Object.fromEntries(attributesList);
 }
 
-export function midsceneGenerateHash(
+export function rpasceneGenerateHash(
   node: globalThis.Node | null,
   content: string,
   rect: Rect,
@@ -400,7 +400,7 @@ export function midsceneGenerateHash(
   const slicedHash = generateHashId(rect, content);
 
   if (node) {
-    if (!(window as any).midsceneNodeHashCacheList) {
+    if (!(window as any).rpasceneNodeHashCacheList) {
       setNodeHashCacheListOnWindow();
     }
 
@@ -413,7 +413,7 @@ export function midsceneGenerateHash(
 
 export function setNodeHashCacheListOnWindow() {
   if (typeof window !== 'undefined') {
-    (window as any).midsceneNodeHashCacheList = [];
+    (window as any).rpasceneNodeHashCacheList = [];
   }
 }
 
@@ -422,13 +422,13 @@ export function setNodeToCacheList(node: globalThis.Node, id: string) {
     if (getNodeFromCacheList(id)) {
       return;
     }
-    (window as any).midsceneNodeHashCacheList?.push({ node, id });
+    (window as any).rpasceneNodeHashCacheList?.push({ node, id });
   }
 }
 
 export function getNodeFromCacheList(id: string) {
   if (typeof window !== 'undefined') {
-    return (window as any).midsceneNodeHashCacheList?.find(
+    return (window as any).rpasceneNodeHashCacheList?.find(
       (item: { node: Node; id: string }) => item.id === id,
     )?.node;
   }
@@ -446,13 +446,13 @@ export function generateId(numberId: number) {
 
 export function setGenerateHashOnWindow() {
   if (typeof window !== 'undefined') {
-    (window as any).midsceneGenerateHash = midsceneGenerateHash;
+    (window as any).rpasceneGenerateHash = rpasceneGenerateHash;
   }
 }
 
-export function setMidsceneVisibleRectOnWindow() {
+export function setRpasceneVisibleRectOnWindow() {
   if (typeof window !== 'undefined') {
-    (window as any).midsceneVisibleRect = elementRect;
+    (window as any).rpasceneVisibleRect = elementRect;
   }
 }
 

package/src/extractor/web-extractor.ts

@@ -21,7 +21,7 @@ import {
   getRect,
   getTopDocument,
   logger,
-  midsceneGenerateHash,
+  rpasceneGenerateHash,
   setDebugMode,
 } from './util';
 import { postWindowMessage, onWindowMessage } from './cs_postmessage';
@@ -83,7 +83,7 @@ export function collectElementInfo(
     const attributes = getNodeAttributes(node, currentWindow);
     let valueContent =
       attributes.value || attributes.placeholder || node.textContent || '';
-    const nodeHashId = midsceneGenerateHash(node, valueContent, rect);
+    const nodeHashId = rpasceneGenerateHash(node, valueContent, rect);
     const tagName = (node as HTMLElement).tagName.toLowerCase();
     if ((node as HTMLElement).tagName.toLowerCase() === 'select') {
       // Get the selected option using the selectedIndex property
@@ -138,7 +138,7 @@ export function collectElementInfo(
     const attributes = getNodeAttributes(node, currentWindow);
     const pseudo = getPseudoElementContent(node, currentWindow);
     const content = node.innerText || pseudo.before || pseudo.after || '';
-    const nodeHashId = midsceneGenerateHash(node, content, rect);
+    const nodeHashId = rpasceneGenerateHash(node, content, rect);
     const elementInfo: WebElementInfo = {
       id: nodeHashId,
       indexId: indexId++,
@@ -163,7 +163,7 @@ export function collectElementInfo(
 
   if (isImgElement(node, currentWindow)) {
     const attributes = getNodeAttributes(node, currentWindow);
-    const nodeHashId = midsceneGenerateHash(node, '', rect);
+    const nodeHashId = rpasceneGenerateHash(node, '', rect);
     const elementInfo: WebElementInfo = {
       id: nodeHashId,
       indexId: indexId++,
@@ -201,7 +201,7 @@ export function collectElementInfo(
     if (!text.trim() && attributeKeys.length === 0) {
       return null;
     }
-    const nodeHashId = midsceneGenerateHash(node, text, rect);
+    const nodeHashId = rpasceneGenerateHash(node, text, rect);
     const elementInfo: WebElementInfo = {
       id: nodeHashId,
       indexId: indexId++,
@@ -228,7 +228,7 @@ export function collectElementInfo(
     const attributes = getNodeAttributes(node, currentWindow);
     const pseudo = getPseudoElementContent(node, currentWindow);
     const content = node.innerText || pseudo.before || pseudo.after || '';
-    const nodeHashId = midsceneGenerateHash(node, content, rect);
+    const nodeHashId = rpasceneGenerateHash(node, content, rect);
     const elementInfo: WebElementInfo = {
       id: nodeHashId,
       indexId: indexId++,
@@ -255,7 +255,7 @@ export function collectElementInfo(
   // 视为容器
   if (isContainerElement(node, currentWindow) || isContainer) {
     const attributes = getNodeAttributes(node, currentWindow);
-    const nodeHashId = midsceneGenerateHash(node, '', rect);
+    const nodeHashId = rpasceneGenerateHash(node, '', rect);
     const elementInfo: WebElementInfo = {
       id: nodeHashId,
       nodeHashId,

package/src/logger.ts

@@ -2,10 +2,10 @@ import fs from 'node:fs';
 import path from 'node:path';
 import util from 'node:util';
 import debug from 'debug';
-import { getMidsceneRunSubDir } from './common';
+import { getRpasceneRunSubDir } from './common';
 import { ifInNode } from './utils';
 
-const topicPrefix = 'midscene';
+const topicPrefix = 'rpascene';
 // Map to store file streams
 const logStreams = new Map<string, fs.WriteStream>();
 // Map to store debug instances
@@ -16,7 +16,7 @@ function getLogStream(topic: string): fs.WriteStream {
   const topicFileName = topic.replace(/:/g, '-');
   if (!logStreams.has(topicFileName)) {
     const logFile = path.join(
-      getMidsceneRunSubDir('log'),
+      getRpasceneRunSubDir('log'),
       `${topicFileName}.log`,
     );
     const stream = fs.createWriteStream(logFile, { flags: 'a' });

package/src/node/fs.ts

@@ -27,14 +27,14 @@ export function getRunningPkgInfo(dir?: string): PkgInfo | null {
   if (pkgDir && pkgJsonFile) {
     const { name, version } = JSON.parse(readFileSync(pkgJsonFile, 'utf-8'));
     pkgCacheMap[dirToCheck] = {
-      name: name || 'midscene-unknown-package-name',
+      name: name || 'rpascene-unknown-package-name',
       version: version || '0.0.0',
       dir: pkgDir,
     };
     return pkgCacheMap[dirToCheck];
   }
   return {
-    name: 'midscene-unknown-package-name',
+    name: 'rpascene-unknown-package-name',
     version: '0.0.0',
     dir: dirToCheck,
   };
@@ -75,10 +75,10 @@ export async function getExtraReturnLogic(tree = false) {
     return null;
   }
 
-  const elementInfosScriptContent = `;midscene_element_inspector.setNodeHashCacheListOnWindow();`;
+  const elementInfosScriptContent = `;rpascene_element_inspector.setNodeHashCacheListOnWindow();`;
 
   if (tree) {
-    return `${elementInfosScriptContent};midscene_element_inspector.webExtractNodeTree()`;
+    return `${elementInfosScriptContent};rpascene_element_inspector.webExtractNodeTree()`;
   }
-  return `${elementInfosScriptContent};midscene_element_inspector.webExtractTextWithPosition()`;
+  return `${elementInfosScriptContent};rpascene_element_inspector.webExtractTextWithPosition()`;
 }

package/src/utils.ts

@@ -105,8 +105,8 @@ export async function repeat(
 
 const REGEXP_LT = /</g;
 const REGEXP_GT = />/g;
-const REGEXP_LT_ESCAPE = '__midscene_lt__';
-const REGEXP_GT_ESCAPE = '__midscene_gt__';
+const REGEXP_LT_ESCAPE = '__rpascene_lt__';
+const REGEXP_GT_ESCAPE = '__rpascene_gt__';
 
 export const escapeScriptTag = (html: string) => {
   return html