@rpascene/shared 0.30.9 → 0.30.11

package/README.md

@@ -2,8 +2,7 @@
 
 An AI-powered automation SDK can control the page, perform assertions, and extract data in JSON format using natural language.
 
-See https://midscenejs.com/ for details.
-
+ 
 ## License
 
-Midscene is MIT licensed.
+Rpascene is MIT licensed.

package/dist/es/common.mjs

@@ -4,14 +4,14 @@ import node_path from "node:path";
 import { getBasicEnvValue } from "./env/basic.mjs";
 import { MIDSCENE_RUN_DIR } from "./env/types.mjs";
 import { ifInNode } from "./utils.mjs";
-const defaultRunDirName = 'midscene_run';
-const getMidsceneRunDir = ()=>{
+const defaultRunDirName = 'rpascene_run';
+const getRpasceneRunDir = ()=>{
     if (!ifInNode) return '';
     return getBasicEnvValue(MIDSCENE_RUN_DIR) || defaultRunDirName;
 };
-const getMidsceneRunBaseDir = ()=>{
+const getRpasceneRunBaseDir = ()=>{
     if (!ifInNode) return '';
-    let basePath = node_path.resolve(process.cwd(), getMidsceneRunDir());
+    let basePath = node_path.resolve(process.cwd(), getRpasceneRunDir());
     if (!existsSync(basePath)) try {
         mkdirSync(basePath, {
             recursive: true
@@ -24,9 +24,9 @@ const getMidsceneRunBaseDir = ()=>{
     }
     return basePath;
 };
-const getMidsceneRunSubDir = (subdir)=>{
+const getRpasceneRunSubDir = (subdir)=>{
     if (!ifInNode) return '';
-    const basePath = getMidsceneRunBaseDir();
+    const basePath = getRpasceneRunBaseDir();
     const logPath = node_path.join(basePath, subdir);
     if (!existsSync(logPath)) mkdirSync(logPath, {
         recursive: true
@@ -34,4 +34,4 @@ const getMidsceneRunSubDir = (subdir)=>{
     return logPath;
 };
 const ERROR_CODE_NOT_IMPLEMENTED_AS_DESIGNED = 'NOT_IMPLEMENTED_AS_DESIGNED';
-export { ERROR_CODE_NOT_IMPLEMENTED_AS_DESIGNED, defaultRunDirName, getMidsceneRunBaseDir, getMidsceneRunDir, getMidsceneRunSubDir };
+export { ERROR_CODE_NOT_IMPLEMENTED_AS_DESIGNED, defaultRunDirName, getRpasceneRunBaseDir, getRpasceneRunDir, getRpasceneRunSubDir };

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

@@ -1,6 +1,6 @@
 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';
@@ -127,33 +127,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.
@@ -163,7 +163,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/dist/es/env/init-debug.mjs

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

package/dist/es/env/model-config-manager.mjs

@@ -83,7 +83,7 @@ class ModelConfigManager {
     }
     throwErrorIfNonVLModel(intent = 'grounding') {
         const modelConfig = this.getModelConfig(intent);
-        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');
+        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://rpascenejs.com/choose-a-model');
     }
     constructor(modelConfigFn){
         _define_property(this, "modelConfigMap", void 0);

package/dist/es/extractor/debug.mjs

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

package/dist/es/extractor/util.mjs

@@ -197,22 +197,22 @@ function getNodeAttributes(node, currentWindow) {
     });
     return Object.fromEntries(attributesList);
 }
-function midsceneGenerateHash(node, content, rect) {
+function rpasceneGenerateHash(node, content, rect) {
     const slicedHash = generateHashId(rect, content);
     if (node) {
-        if (!window.midsceneNodeHashCacheList) setNodeHashCacheListOnWindow();
+        if (!window.rpasceneNodeHashCacheList) setNodeHashCacheListOnWindow();
         setNodeToCacheList(node, slicedHash);
     }
     return slicedHash;
 }
 function setNodeHashCacheListOnWindow() {
-    if ('undefined' != typeof window) window.midsceneNodeHashCacheList = [];
+    if ('undefined' != typeof window) window.rpasceneNodeHashCacheList = [];
 }
 function setNodeToCacheList(node, id) {
     if ('undefined' != typeof window) {
-        var _window_midsceneNodeHashCacheList;
+        var _window_rpasceneNodeHashCacheList;
         if (getNodeFromCacheList(id)) return;
-        null == (_window_midsceneNodeHashCacheList = window.midsceneNodeHashCacheList) || _window_midsceneNodeHashCacheList.push({
+        null == (_window_rpasceneNodeHashCacheList = window.rpasceneNodeHashCacheList) || _window_rpasceneNodeHashCacheList.push({
             node,
             id
         });
@@ -220,8 +220,8 @@ function setNodeToCacheList(node, id) {
 }
 function getNodeFromCacheList(id) {
     if ('undefined' != typeof window) {
-        var _window_midsceneNodeHashCacheList_find, _window_midsceneNodeHashCacheList;
-        return null == (_window_midsceneNodeHashCacheList = window.midsceneNodeHashCacheList) ? void 0 : null == (_window_midsceneNodeHashCacheList_find = _window_midsceneNodeHashCacheList.find((item)=>item.id === id)) ? void 0 : _window_midsceneNodeHashCacheList_find.node;
+        var _window_rpasceneNodeHashCacheList_find, _window_rpasceneNodeHashCacheList;
+        return null == (_window_rpasceneNodeHashCacheList = window.rpasceneNodeHashCacheList) ? void 0 : null == (_window_rpasceneNodeHashCacheList_find = _window_rpasceneNodeHashCacheList.find((item)=>item.id === id)) ? void 0 : _window_rpasceneNodeHashCacheList_find.node;
     }
     return null;
 }
@@ -229,10 +229,10 @@ function generateId(numberId) {
     return `${numberId}`;
 }
 function setGenerateHashOnWindow() {
-    if ('undefined' != typeof window) window.midsceneGenerateHash = midsceneGenerateHash;
+    if ('undefined' != typeof window) window.rpasceneGenerateHash = rpasceneGenerateHash;
 }
-function setMidsceneVisibleRectOnWindow() {
-    if ('undefined' != typeof window) window.midsceneVisibleRect = elementRect;
+function setRpasceneVisibleRectOnWindow() {
+    if ('undefined' != typeof window) window.rpasceneVisibleRect = elementRect;
 }
 function setExtractTextWithPositionOnWindow() {
     if ('undefined' != typeof window) window.extractTextWithPosition = extractTextWithPosition;
@@ -241,4 +241,4 @@ function getTopDocument() {
     const container = document.body || document;
     return container;
 }
-export { elementRect, generateId, getDebugMode, getNodeAttributes, getNodeFromCacheList, getPseudoElementContent, getRect, getTopDocument, hasOverflowY, isElementPartiallyInViewport, logger, midsceneGenerateHash, overlappedRect, setDebugMode, setExtractTextWithPositionOnWindow, setGenerateHashOnWindow, setMidsceneVisibleRectOnWindow, setNodeHashCacheListOnWindow, setNodeToCacheList, validTextNodeContent };
+export { elementRect, generateId, getDebugMode, getNodeAttributes, getNodeFromCacheList, getPseudoElementContent, getRect, getTopDocument, hasOverflowY, isElementPartiallyInViewport, logger, overlappedRect, rpasceneGenerateHash, setDebugMode, setExtractTextWithPositionOnWindow, setGenerateHashOnWindow, setNodeHashCacheListOnWindow, setNodeToCacheList, setRpasceneVisibleRectOnWindow, validTextNodeContent };

package/dist/es/extractor/web-extractor.mjs

@@ -1,7 +1,7 @@
 import { CONTAINER_MINI_HEIGHT, CONTAINER_MINI_WIDTH, NodeType } from "../constants/index.mjs";
 import { isAElement, isButtonElement, isContainerElement, isFormElement, isImgElement, isTextElement } from "./dom-util.mjs";
 import { descriptionOfTree } from "./tree.mjs";
-import { elementRect, getNodeAttributes, getPseudoElementContent, getRect, getTopDocument, logger, midsceneGenerateHash, setDebugMode } from "./util.mjs";
+import { elementRect, getNodeAttributes, getPseudoElementContent, getRect, getTopDocument, logger, rpasceneGenerateHash, setDebugMode } from "./util.mjs";
 import { onWindowMessage, postWindowMessage } from "./cs_postmessage.mjs";
 import { getContainerPath, getLocators } from "./customLocator.mjs";
 let indexId = 0;
@@ -34,7 +34,7 @@ function collectElementInfo(node, currentWindow, currentDocument, baseZoom = 1,
     if (isFormElement(node, currentWindow)) {
         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.tagName.toLowerCase();
         if ('select' === node.tagName.toLowerCase()) {
             const selectedOption = node.options[node.selectedIndex];
@@ -68,7 +68,7 @@ function collectElementInfo(node, currentWindow, currentDocument, baseZoom = 1,
         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 = {
             id: nodeHashId,
             indexId: indexId++,
@@ -93,7 +93,7 @@ function collectElementInfo(node, currentWindow, currentDocument, baseZoom = 1,
     if (isImgElement(node, currentWindow)) {
         var _node_nodeName;
         const attributes = getNodeAttributes(node, currentWindow);
-        const nodeHashId = midsceneGenerateHash(node, '', rect);
+        const nodeHashId = rpasceneGenerateHash(node, '', rect);
         const elementInfo = {
             id: nodeHashId,
             indexId: indexId++,
@@ -125,7 +125,7 @@ function collectElementInfo(node, currentWindow, currentDocument, baseZoom = 1,
         const attributes = getNodeAttributes(node, currentWindow);
         const attributeKeys = Object.keys(attributes);
         if (!text.trim() && 0 === attributeKeys.length) return null;
-        const nodeHashId = midsceneGenerateHash(node, text, rect);
+        const nodeHashId = rpasceneGenerateHash(node, text, rect);
         const elementInfo = {
             id: nodeHashId,
             indexId: indexId++,
@@ -151,7 +151,7 @@ function collectElementInfo(node, currentWindow, currentDocument, baseZoom = 1,
         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 = {
             id: nodeHashId,
             indexId: indexId++,
@@ -175,7 +175,7 @@ function collectElementInfo(node, currentWindow, currentDocument, baseZoom = 1,
     }
     if (isContainerElement(node, currentWindow) || isContainer) {
         const attributes = getNodeAttributes(node, currentWindow);
-        const nodeHashId = midsceneGenerateHash(node, '', rect);
+        const nodeHashId = rpasceneGenerateHash(node, '', rect);
         const elementInfo = {
             id: nodeHashId,
             nodeHashId,

package/dist/es/logger.mjs

@@ -2,15 +2,15 @@ import node_fs from "node:fs";
 import node_path from "node:path";
 import node_util from "node:util";
 import debug from "debug";
-import { getMidsceneRunSubDir } from "./common.mjs";
+import { getRpasceneRunSubDir } from "./common.mjs";
 import { ifInNode } from "./utils.mjs";
-const topicPrefix = 'midscene';
+const topicPrefix = 'rpascene';
 const logStreams = new Map();
 const debugInstances = new Map();
 function getLogStream(topic) {
     const topicFileName = topic.replace(/:/g, '-');
     if (!logStreams.has(topicFileName)) {
-        const logFile = node_path.join(getMidsceneRunSubDir('log'), `${topicFileName}.log`);
+        const logFile = node_path.join(getRpasceneRunSubDir('log'), `${topicFileName}.log`);
         const stream = node_fs.createWriteStream(logFile, {
             flags: 'a'
         });