misoai-web 1.0.2 → 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,9 +1,9 @@
-## Documentation
-
-Automate UI actions, extract data, and perform assertions using AI. It offers JavaScript SDK, Chrome extension, and support for scripting in YAML.
-
-See https://midscenejs.com/ for details.
-
-## License
-
+## Documentation
+
+Automate UI actions, extract data, and perform assertions using AI. It offers JavaScript SDK, Chrome extension, and support for scripting in YAML.
+
+See https://midscenejs.com/ for details.
+
+## License
+
 Midscene is MIT licensed.

package/bin/midscene-playground

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
-
+#!/usr/bin/env node
+
 require('../dist/lib/midscene-playground.js');

package/dist/es/agent.js

@@ -88,7 +88,9 @@ var ScriptPlayer = class {
           typeof prompt === "string",
           "prompt for aiAction must be a string"
         );
-        await agent.aiAction(prompt);
+        await agent.aiAction(prompt, {
+          cacheable: actionTask.cacheable
+        });
       } else if ("aiAssert" in flowItem) {
         const assertTask = flowItem;
         const prompt = assertTask.aiAssert;
@@ -290,8 +292,24 @@ function interpolateEnvVars(content) {
   });
 }
 function parseYamlScript(content, filePath, ignoreCheckingTarget) {
-  const interpolatedContent = interpolateEnvVars(content);
-  const obj = yaml2.load(interpolatedContent);
+  let processedContent = content;
+  if (content.indexOf("android") !== -1 && content.match(/deviceId:\s*(\d+)/)) {
+    let matchedDeviceId;
+    processedContent = content.replace(
+      /deviceId:\s*(\d+)/g,
+      (match, deviceId) => {
+        matchedDeviceId = deviceId;
+        return `deviceId: '${deviceId}'`;
+      }
+    );
+    console.warn(
+      `please use string-style deviceId in yaml script, for example: deviceId: "${matchedDeviceId}"`
+    );
+  }
+  const interpolatedContent = interpolateEnvVars(processedContent);
+  const obj = yaml2.load(interpolatedContent, {
+    schema: yaml2.JSON_SCHEMA
+  });
   const pathTip = filePath ? `, failed to load ${filePath}` : "";
   const android = typeof obj.android !== "undefined" ? Object.assign({}, obj.android || {}) : void 0;
   const webConfig = obj.web || obj.target;
@@ -347,7 +365,6 @@ import {
 } from "misoai-core/ai-model";
 import { sleep } from "misoai-core/utils";
 import { NodeType } from "misoai-shared/constants";
-import { getElementInfosScriptContent } from "misoai-shared/fs";
 import { getDebug } from "misoai-shared/logger";
 import { assert as assert4 } from "misoai-shared/utils";
 
@@ -584,16 +601,18 @@ var PageTaskExecutor = class {
       );
       if (info?.id) {
         elementId = info.id;
+      } else {
+        debug(
+          "no element id found for position node, will not update cache",
+          element
+        );
       }
     }
     if (!elementId) {
       return void 0;
     }
     try {
-      const elementInfosScriptContent = getElementInfosScriptContent();
-      const result = await this.page.evaluateJavaScript?.(
-        `${elementInfosScriptContent}midscene_element_inspector.getXpathsById('${elementId}')`
-      );
+      const result = await this.page.getXpathsById(elementId);
       return result;
     } catch (error) {
       debug("getXpathsById error: ", error);
@@ -632,7 +651,7 @@ var PageTaskExecutor = class {
     };
     return taskWithScreenshot;
   }
-  async convertPlanToExecutable(plans) {
+  async convertPlanToExecutable(plans, opts) {
     const tasks = [];
     plans.forEach((plan2) => {
       if (plan2.type === "Locate") {
@@ -642,7 +661,10 @@ var PageTaskExecutor = class {
         const taskFind = {
           type: "Insight",
           subType: "Locate",
-          param: plan2.locate || void 0,
+          param: plan2.locate ? {
+            ...plan2.locate,
+            cacheable: opts?.cacheable
+          } : void 0,
           thought: plan2.thought,
           locate: plan2.locate,
           executor: async (param, taskContext) => {
@@ -679,19 +701,21 @@ var PageTaskExecutor = class {
             let elementFromCache = null;
             try {
               if (xpaths?.length && this.taskCache?.isCacheResultUsed && param?.cacheable !== false) {
-                const elementInfosScriptContent = getElementInfosScriptContent();
-                const element2 = await this.page.evaluateJavaScript?.(
-                  `${elementInfosScriptContent}midscene_element_inspector.getElementInfoByXpath('${xpaths[0]}')`
-                );
-                if (element2?.id) {
-                  elementFromCache = element2;
-                  debug("cache hit, prompt: %s", cachePrompt);
-                  cacheHitFlag = true;
-                  debug(
-                    "found a new new element with same xpath, xpath: %s, id: %s",
-                    xpaths[0],
-                    element2?.id
+                for (let i = 0; i < xpaths.length; i++) {
+                  const element2 = await this.page.getElementInfoByXpath(
+                    xpaths[i]
                   );
+                  if (element2?.id) {
+                    elementFromCache = element2;
+                    debug("cache hit, prompt: %s", cachePrompt);
+                    cacheHitFlag = true;
+                    debug(
+                      "found a new new element with same xpath, xpath: %s, id: %s",
+                      xpaths[i],
+                      element2?.id
+                    );
+                    break;
+                  }
                 }
               }
             } catch (error) {
@@ -704,12 +728,14 @@ var PageTaskExecutor = class {
               context: pageContext
             })).element;
             const aiCost = Date.now() - startTime;
+            let currentXpaths;
             if (element && this.taskCache && !cacheHitFlag && param?.cacheable !== false) {
               const elementXpaths = await this.getElementXpath(
                 pageContext,
                 element
               );
-              if (elementXpaths) {
+              if (elementXpaths?.length) {
+                currentXpaths = elementXpaths;
                 this.taskCache.updateOrAppendCacheRecord(
                   {
                     type: "locate",
@@ -719,7 +745,11 @@ var PageTaskExecutor = class {
                   locateCacheRecord
                 );
               } else {
-                debug("no xpaths found, will not update cache", cachePrompt);
+                debug(
+                  "no xpaths found, will not update cache",
+                  cachePrompt,
+                  elementXpaths
+                );
               }
             }
             if (!element) {
@@ -731,7 +761,9 @@ var PageTaskExecutor = class {
               },
               pageContext,
               cache: {
-                hit: cacheHitFlag
+                hit: cacheHitFlag,
+                originalXpaths: xpaths,
+                currentXpaths
               },
               aiCost
             };
@@ -1099,6 +1131,7 @@ var PageTaskExecutor = class {
           sleep: sleep2
         } = planResult;
         executorContext.task.log = {
+          ...executorContext.task.log || {},
           rawResponse
         };
         executorContext.task.usage = usage;
@@ -1223,11 +1256,11 @@ var PageTaskExecutor = class {
     };
     return task;
   }
-  async runPlans(title, plans) {
+  async runPlans(title, plans, opts) {
     const taskExecutor = new Executor(title, {
       onTaskStart: this.onTaskStartCallback
     });
-    const { tasks } = await this.convertPlanToExecutable(plans);
+    const { tasks } = await this.convertPlanToExecutable(plans, opts);
     await taskExecutor.append(tasks);
     const result = await taskExecutor.flush();
     return {
@@ -1235,7 +1268,7 @@ var PageTaskExecutor = class {
       executor: taskExecutor
     };
   }
-  async action(userPrompt, actionContext) {
+  async action(userPrompt, actionContext, opts) {
     const taskExecutor = new Executor(taskTitleStr("Action", userPrompt), {
       onTaskStart: this.onTaskStartCallback
     });
@@ -1260,7 +1293,7 @@ var PageTaskExecutor = class {
       yamlFlow.push(...planResult.yamlFlow || []);
       let executables;
       try {
-        executables = await this.convertPlanToExecutable(plans);
+        executables = await this.convertPlanToExecutable(plans, opts);
         taskExecutor.append(executables.tasks);
       } catch (error) {
         return this.appendErrorPlan(
@@ -1298,7 +1331,7 @@ var PageTaskExecutor = class {
       executor: taskExecutor
     };
   }
-  async actionToGoal(userPrompt) {
+  async actionToGoal(userPrompt, opts) {
     const taskExecutor = new Executor(taskTitleStr("Action", userPrompt), {
       onTaskStart: this.onTaskStartCallback
     });
@@ -1322,7 +1355,7 @@ var PageTaskExecutor = class {
       yamlFlow.push(...output.yamlFlow || []);
       let executables;
       try {
-        executables = await this.convertPlanToExecutable(plans);
+        executables = await this.convertPlanToExecutable(plans, opts);
         taskExecutor.append(executables.tasks);
       } catch (error) {
         return this.appendErrorPlan(
@@ -1627,7 +1660,7 @@ import yaml3 from "js-yaml";
 import semver from "semver";
 
 // package.json
-var version = "1.0.2";
+var version = "1.0.4";
 
 // src/common/task-cache.ts
 var debug3 = getDebug3("cache");
@@ -1970,9 +2003,9 @@ var PageAgent = class {
   buildDetailedLocateParam(locatePrompt, opt) {
     assert7(locatePrompt, "missing locate prompt");
     if (typeof opt === "object") {
-      const prompt = opt.prompt || locatePrompt;
-      const deepThink = opt.deepThink || false;
-      const cacheable = opt.cacheable || true;
+      const prompt = opt.prompt ?? locatePrompt;
+      const deepThink = opt.deepThink ?? false;
+      const cacheable = opt.cacheable ?? true;
       return {
         prompt,
         deepThink,
@@ -1991,7 +2024,8 @@ var PageAgent = class {
     const plans = buildPlans("Tap", detailedLocateParam);
     const { executor, output } = await this.taskExecutor.runPlans(
       taskTitleStr("Tap", locateParamStr(detailedLocateParam)),
-      plans
+      plans,
+      { cacheable: opt?.cacheable }
     );
     const metadata = this.afterTaskRunning(executor);
     return {
@@ -2007,7 +2041,8 @@ var PageAgent = class {
     const plans = buildPlans("Hover", detailedLocateParam);
     const { executor, output } = await this.taskExecutor.runPlans(
       taskTitleStr("Hover", locateParamStr(detailedLocateParam)),
-      plans
+      plans,
+      { cacheable: opt?.cacheable }
     );
     const metadata = this.afterTaskRunning(executor);
     return {
@@ -2030,7 +2065,8 @@ var PageAgent = class {
     });
     const { executor, output } = await this.taskExecutor.runPlans(
       taskTitleStr("Input", locateParamStr(detailedLocateParam)),
-      plans
+      plans,
+      { cacheable: opt?.cacheable }
     );
     const metadata = this.afterTaskRunning(executor);
     return {
@@ -2046,7 +2082,8 @@ var PageAgent = class {
     });
     const { executor, output } = await this.taskExecutor.runPlans(
       taskTitleStr("KeyboardPress", locateParamStr(detailedLocateParam)),
-      plans
+      plans,
+      { cacheable: opt?.cacheable }
     );
     const metadata = this.afterTaskRunning(executor);
     return {
@@ -2060,7 +2097,8 @@ var PageAgent = class {
     const paramInTitle = locatePrompt ? `${locateParamStr(detailedLocateParam)} - ${scrollParamStr(scrollParam)}` : scrollParamStr(scrollParam);
     const { executor, output } = await this.taskExecutor.runPlans(
       taskTitleStr("Scroll", paramInTitle),
-      plans
+      plans,
+      { cacheable: opt?.cacheable }
     );
     const metadata = this.afterTaskRunning(executor);
     return {
@@ -2069,6 +2107,19 @@ var PageAgent = class {
     };
   }
   async aiAction(taskPrompt, opt) {
+    try {
+      const aiModel = await import("misoai-core/ai-model");
+      const contextStore = aiModel.getContextStore();
+      const processedPrompt = contextStore.replaceAllReferences(taskPrompt, "action");
+      contextStore.addStep({
+        type: "action",
+        summary: `Action: ${processedPrompt}`,
+        prompt: processedPrompt
+      });
+      taskPrompt = processedPrompt;
+    } catch (error) {
+      debug4("Context store not available:", error);
+    }
     const cacheable = opt?.cacheable;
     const isVlmUiTars = vlLocateMode() === "vlm-ui-tars";
     const matchedCache = isVlmUiTars || cacheable === false ? void 0 : this.taskCache?.matchPlanCache(taskPrompt);
@@ -2086,7 +2137,9 @@ var PageAgent = class {
         metadata: metadata2
       };
     }
-    const { output, executor } = await (isVlmUiTars ? this.taskExecutor.actionToGoal(taskPrompt) : this.taskExecutor.action(taskPrompt, this.opts.aiActionContext));
+    const { output, executor } = await (isVlmUiTars ? this.taskExecutor.actionToGoal(taskPrompt, { cacheable }) : this.taskExecutor.action(taskPrompt, this.opts.aiActionContext, {
+      cacheable
+    }));
     if (this.taskCache && output?.yamlFlow && cacheable !== false) {
       const yamlContent = {
         tasks: [
@@ -2113,7 +2166,63 @@ var PageAgent = class {
     };
   }
   async aiQuery(demand) {
-    const { output, executor } = await this.taskExecutor.query(demand);
+    let processedDemand = demand;
+    let storageKey;
+    try {
+      const aiModel = await import("misoai-core/ai-model");
+      const contextStore = aiModel.getContextStore();
+      if (typeof demand === "string") {
+        const storageInstruction = contextStore.parseStorageInstruction(demand);
+        if (storageInstruction) {
+          storageKey = storageInstruction.key;
+          processedDemand = storageInstruction.cleanText;
+          contextStore._pendingAliases = storageInstruction.aliases;
+        } else {
+          const storageMatch = demand.match(/store\s+(?:as\s+)?(\w+)/i);
+          if (storageMatch) {
+            storageKey = storageMatch[1];
+            processedDemand = demand.replace(/,?\s*store\s+(?:as\s+)?\w+/i, "").trim();
+          }
+        }
+      }
+    } catch (error) {
+      debug4("Context store not available:", error);
+    }
+    const { output, executor } = await this.taskExecutor.query(processedDemand);
+    if (storageKey && output) {
+      try {
+        const aiModel = await import("misoai-core/ai-model");
+        const contextStore = aiModel.getContextStore();
+        const pendingAliases = contextStore._pendingAliases;
+        if (pendingAliases) {
+          contextStore.storeDataWithAliases(storageKey, output, pendingAliases, typeof processedDemand === "string" ? processedDemand : JSON.stringify(processedDemand));
+          delete contextStore._pendingAliases;
+        } else {
+          contextStore.storeData(storageKey, output);
+        }
+        contextStore.addStep({
+          type: "query",
+          summary: `Query: ${typeof processedDemand === "string" ? processedDemand : JSON.stringify(processedDemand)} (stored as ${storageKey})`,
+          data: output,
+          prompt: typeof processedDemand === "string" ? processedDemand : JSON.stringify(processedDemand)
+        });
+      } catch (error) {
+        debug4("Failed to store query result:", error);
+      }
+    } else {
+      try {
+        const aiModel = await import("misoai-core/ai-model");
+        const contextStore = aiModel.getContextStore();
+        contextStore.addStep({
+          type: "query",
+          summary: `Query: ${typeof processedDemand === "string" ? processedDemand : JSON.stringify(processedDemand)}`,
+          data: output,
+          prompt: typeof processedDemand === "string" ? processedDemand : JSON.stringify(processedDemand)
+        });
+      } catch (error) {
+        debug4("Failed to add query step:", error);
+      }
+    }
     const metadata = this.afterTaskRunning(executor);
     return {
       result: output,
@@ -2208,7 +2317,8 @@ var PageAgent = class {
     const plans = buildPlans("Locate", detailedLocateParam);
     const { executor, output } = await this.taskExecutor.runPlans(
       taskTitleStr("Locate", locateParamStr(detailedLocateParam)),
-      plans
+      plans,
+      { cacheable: opt?.cacheable }
     );
     const metadata = this.afterTaskRunning(executor);
     const { element } = output;
@@ -2222,6 +2332,19 @@ var PageAgent = class {
     };
   }
   async aiAssert(assertion, msg, opt) {
+    let processedAssertion = assertion;
+    try {
+      const aiModel = await import("misoai-core/ai-model");
+      const contextStore = aiModel.getContextStore();
+      processedAssertion = contextStore.replaceAllReferences(assertion, "assertion");
+      contextStore.addStep({
+        type: "assertion",
+        summary: `Assertion: ${processedAssertion}`,
+        prompt: processedAssertion
+      });
+    } catch (error) {
+      debug4("Context store not available:", error);
+    }
     let currentUrl = "";
     if (this.page.url) {
       try {
@@ -2229,7 +2352,7 @@ var PageAgent = class {
       } catch (e) {
       }
     }
-    const assertionWithContext = currentUrl ? `For the page at URL "${currentUrl}", ${assertion}` : assertion;
+    const assertionWithContext = currentUrl ? `For the page at URL "${currentUrl}", ${processedAssertion}` : processedAssertion;
     const { output, executor } = await this.taskExecutor.assert(assertionWithContext);
     const metadata = this.afterTaskRunning(executor, true);
     if (output && opt?.keepRawResponse) {