wuying-agentbay-sdk 0.12.0 → 0.13.0

package/docs/examples/browser-use/browser/run-sudoku.ts

@@ -6,20 +6,28 @@
  * - Utilize PageUseAgent to run sudoku game
  */
 
-import { AgentBay, CreateSessionParams,BrowserOption, ExtractOptions, ActOptions } from 'wuying-agentbay-sdk';
-
-import { chromium } from 'playwright';
-
-class SudokuBoard {
-  board: number[][] = [];
-}
-
-class SudokuSolution {
-  solution: number[][] = [];
-}
-
+import {
+  AgentBay,
+  CreateSessionParams,
+  BrowserOption,
+  ExtractOptions,
+  ActOptions,
+} from "wuying-agentbay-sdk";
+
+import { chromium } from "playwright";
+import { z } from "zod";
+
+const SudokuBoardSchema = z.object({
+  board: z.array(z.array(z.number())),
+});
+type SudokuBoardType = z.infer<typeof SudokuBoardSchema>;
+
+const SudokuSolutionSchema = z.object({
+  solution: z.array(z.array(z.number())),
+});
+type SudokuSolutionType = z.infer<typeof SudokuSolutionSchema>;
 function formatBoardForLlm(board: number[][]): string {
-  return board.map(row => `  [${row.join(', ')}]`).join('\n');
+  return board.map((row) => `  [${row.join(", ")}]`).join("\n");
 }
 
 async function main() {
@@ -52,7 +60,7 @@ async function main() {
 
       const browser = await chromium.connectOverCDP(endpointUrl);
       try {
-        const context = browser.contexts()[0]
+        const context = browser.contexts()[0];
         const page = await context.newPage();
         console.log("🌐 Navigating to Sudoku site...");
         const url = "https://widget.websudoku.com/";
@@ -65,27 +73,31 @@ async function main() {
 
         while (!success) {
           console.log("📊 Extracting sudoku board...");
-          const options: ExtractOptions<SudokuBoard> = {
-            instruction: "Extract the current sudoku board as a 9x9 array. Each cell should be a number (1-9) if filled, or 0 if empty.",
-            schema: SudokuBoard,
-            use_text_extract: false
+          const options: ExtractOptions<typeof SudokuBoardSchema> = {
+            instruction:
+              "Extract the current sudoku board as a 9x9 array. Each cell should be a number (1-9) if filled, or 0 if empty.",
+            schema: SudokuBoardSchema,
+            use_text_extract: false,
           };
 
-          const [extractSuccess, boardObjs] = await session.browser.agent.extract(options, page);
-          if (extractSuccess && boardObjs.length > 0) {
+          const [extractSuccess, boardObj] =
+            await session.browser.agent.extract(options, page);
+          if (extractSuccess && boardObj) {
             success = true;
-            board = boardObjs[0].board;
+            board = boardObj.board;
           } else {
             console.log("❌ Failed to extract sudoku board, retry extracting");
-            await new Promise(resolve => setTimeout(resolve, 3000));
+            await new Promise((resolve) => setTimeout(resolve, 3000));
           }
         }
 
-        console.log("Current Board:\n" + board.map(row => row.join(' ')).join('\n'));
-        const originalBoard = board.map(row => [...row]);
+        console.log(
+          "Current Board:\n" + board.map((row) => row.join(" ")).join("\n")
+        );
+        const originalBoard = board.map((row) => [...row]);
 
         // 2. Solve the sudoku
-        const solutionOptions: ExtractOptions<SudokuSolution> = {
+        const solutionOptions: ExtractOptions<typeof SudokuSolutionSchema> = {
           instruction: `You are an expert sudoku solver. Given the following sudoku board as a 9x9 array (0 means empty), solve the sudoku and return the completed 9x9 array as 'solution'.
 
 Sudoku rules:
@@ -103,39 +115,46 @@ Return:
 {
   solution: number[][] // 9x9, all filled, valid sudoku
 }`,
-          schema: SudokuSolution,
-          use_text_extract: false
+          schema: SudokuSolutionSchema,
+          use_text_extract: false,
         };
 
-        const [solutionSuccess, solutionObjs] = await session.browser.agent.extract(solutionOptions, page);
-        if (!solutionSuccess || solutionObjs.length === 0) {
+        const [solutionSuccess, solutionObj] =
+          await session.browser.agent.extract(solutionOptions, page);
+        if (!solutionSuccess || !solutionObj) {
           console.log("❌ Failed to solve sudoku");
           return;
         }
 
-        const solution = solutionObjs[0].solution;
-        console.log("Solved Board:\n" + solution.map((row:any) => row.join(' ')).join('\n'));
+        const solution = solutionObj.solution;
+        console.log(
+          "Solved Board:\n" +
+            solution.map((row: any) => row.join(" ")).join("\n")
+        );
 
         // 3. Fill the solution
         for (let row = 0; row < 9; row++) {
           for (let col = 0; col < 9; col++) {
             if (originalBoard[row][col] === 0) {
               const inputId = `f${col}${row}`;
-              console.log(`Type '${solution[row][col]}' into the cell with id '${inputId}'`);
+              console.log(
+                `Type '${solution[row][col]}' into the cell with id '${inputId}'`
+              );
 
               // Use the act method for natural language action
               const actOptions: ActOptions = {
-                action: `Enter '${solution[row][col]}' into the input element where the attribute id is exactly '${inputId}' (for example, if id='f53', you must match the full string 'f53', not just the number 53; do not split or extract numbers from the id)`
+                action: `Enter '${solution[row][col]}' into the input element where the attribute id is exactly '${inputId}' (for example, if id='f53', you must match the full string 'f53', not just the number 53; do not split or extract numbers from the id)`,
               };
 
               await session.browser.agent.act(actOptions, page);
-              await new Promise(resolve => setTimeout(resolve, 500));
+              await new Promise((resolve) => setTimeout(resolve, 500));
             }
           }
         }
 
-        console.log("✅ Finished! The board has been solved and filled in the browser.");
-
+        console.log(
+          "✅ Finished! The board has been solved and filled in the browser."
+        );
       } catch (error) {
         console.log(`❌ Error in game loop: ${error}`);
       }

package/docs/examples/browser-use/browser/screenshot-example.ts

@@ -75,8 +75,8 @@ async function main() {
     // console.log(`✅ Browser screenshot captured (${screenshotData.length} bytes)`);
     
     // Save the screenshot to a file
-    // await writeFile("browser_screenshot.png", Buffer.from(screenshotData));
-    // console.log("✅ Browser screenshot saved as browser_screenshot.png");
+    // await writeFile("temp_browser_screenshot.png", Buffer.from(screenshotData));
+// console.log("✅ Browser screenshot saved as temp_browser_screenshot.png");
     
     // Take a full page screenshot with custom options
     // const fullPageData = await session.browser.screenshot(
@@ -90,8 +90,8 @@ async function main() {
     // console.log(`✅ Browser full page screenshot captured (${fullPageData.length} bytes)`);
     
     // Save the full page screenshot
-    // await writeFile("browser_full_page_screenshot.jpg", Buffer.from(fullPageData));
-    // console.log("✅ Browser full page screenshot saved as browser_full_page_screenshot.jpg");
+    // await writeFile("temp_browser_full_page_screenshot.jpg", Buffer.from(fullPageData));
+// console.log("✅ Browser full page screenshot saved as temp_browser_full_page_screenshot.jpg");
     
     // Take a screenshot with custom viewport settings
     // const customScreenshot = await session.browser.screenshot(
@@ -105,8 +105,8 @@ async function main() {
     // console.log(`✅ Browser custom screenshot captured (${customScreenshot.length} bytes)`);
     
     // Save the custom screenshot
-    // await writeFile("browser_custom_screenshot.png", Buffer.from(customScreenshot));
-    // console.log("✅ Browser custom screenshot saved as browser_custom_screenshot.png");
+    // await writeFile("temp_browser_custom_screenshot.png", Buffer.from(customScreenshot));
+// console.log("✅ Browser custom screenshot saved as temp_browser_custom_screenshot.png");
     
     await browser.close();
     

package/docs/examples/browser-use/extension-example/extension-example.ts

@@ -12,7 +12,6 @@
  * - Error handling and cleanup
  */
 
-// @ts-nocheck
 import { AgentBay, ExtensionsService, Extension, ExtensionOption, BrowserContext } from "wuying-agentbay-sdk";
 import * as fs from "fs";
 
@@ -33,7 +32,7 @@ async function basicExtensionExample(): Promise<boolean> {
 
   try {
     // Example extension path (update with your actual extension)
-    const extensionPath = "/Users/shiwen/extension/welcome_extension.zip";
+    const extensionPath = "/path/to/your-extension.zip";
 
     if (!fs.existsSync(extensionPath)) {
       console.log(`❌ Extension file not found: ${extensionPath}`);

package/docs/examples/codespace/enhanced_code/index.ts

@@ -0,0 +1,86 @@
+import { AgentBay } from 'wuying-agentbay-sdk';
+
+async function main() {
+  const apiKey = process.env.AGENTBAY_API_KEY;
+  if (!apiKey) {
+    console.error("Please set AGENTBAY_API_KEY environment variable");
+    process.exit(1);
+  }
+
+  const agentBay = new AgentBay({ apiKey });
+
+  console.log("Creating session...");
+  const sessionResult = await agentBay.create({ imageId: "code_latest" });
+  if (!sessionResult.success || !sessionResult.session) {
+    console.error("Failed to create session:", sessionResult.errorMessage);
+    process.exit(1);
+  }
+
+  const session = sessionResult.session;
+  console.log(`Session created: ${session.sessionId}`);
+
+  try {
+    // 1. Logs Capture
+    console.log("\n--- Logs Capture Test ---");
+    const logsCode = `
+import sys
+print("This goes to stdout")
+print("This goes to stderr", file=sys.stderr)
+`;
+    const logsResult = await session.code.runCode(logsCode, "python");
+    printResult(logsResult);
+
+    // 2. Rich Output (HTML)
+    console.log("\n--- Rich Output (HTML) Test ---");
+    const htmlCode = `
+from IPython.display import display, HTML
+display(HTML("<h1>Hello from AgentBay</h1>"))
+`;
+    const htmlResult = await session.code.runCode(htmlCode, "python");
+    printResult(htmlResult);
+
+    // 3. Error Handling
+    console.log("\n--- Error Handling Test ---");
+    const errorCode = `
+raise ValueError("Something went wrong")
+`;
+    const errorResult = await session.code.runCode(errorCode, "python");
+    printResult(errorResult);
+
+  } finally {
+    console.log("\nCleaning up...");
+    await session.delete();
+  }
+}
+
+function printResult(result: any) {
+  if (result.success) {
+    console.log("Success: true");
+    if (result.logs) {
+      if (result.logs.stdout.length > 0) {
+        console.log("Stdout:", JSON.stringify(result.logs.stdout));
+      }
+      if (result.logs.stderr.length > 0) {
+        console.log("Stderr:", JSON.stringify(result.logs.stderr));
+      }
+    }
+    if (result.results) {
+      console.log("Results count:", result.results.length);
+      result.results.forEach((item: any, index: number) => {
+        const types = Object.keys(item).filter(k => k !== 'isMainResult');
+        console.log(`Result [${index}] types:`, types.join(", "));
+        if (item.text) console.log(`  Text: ${item.text.substring(0, 50)}...`);
+        if (item.html) console.log(`  HTML: ${item.html.substring(0, 50)}...`);
+      });
+    }
+  } else {
+    console.log("Success: false");
+    console.log("Error Message:", result.errorMessage);
+    if (result.error) {
+      console.log("Error Details:", JSON.stringify(result.error));
+    }
+  }
+}
+
+main().catch(console.error);
+

package/docs/examples/common-features/advanced/agent-module-example.ts

@@ -33,7 +33,7 @@ async function main() {
       const taskDescription = "Calculate the square root of 144";
       console.log(`Executing task: ${taskDescription}`);
       
-      const executionResult = await session.agent.executeTask(taskDescription, 5);
+      const executionResult = await session.agent.computer.executeTask(taskDescription, 5);
       
       if (executionResult.success) {
         console.log("Task completed successfully!");

package/docs/examples/common-features/advanced/archive-upload-mode-example/README.md

@@ -45,7 +45,7 @@ const contextSync = newContextSync(
 ### Session Creation with Context Sync
 
 ```typescript
-const sessionParams: CreateSessionParams = {
+const sessionParams = {
   labels: {
     example: `archive-mode-${uniqueId}`,
     type: "archive-upload-demo",

package/docs/examples/common-features/advanced/archive-upload-mode-example/archive-upload-mode-example.ts

@@ -1,4 +1,4 @@
-import { AgentBay, CreateSessionParams, Session, newContextSync, newSyncPolicy, FileSystem } from "wuying-agentbay-sdk";
+import { AgentBay, CreateSessionParams, Session, newContextSync, newSyncPolicy, FileSystem, UploadMode } from "wuying-agentbay-sdk";
 
 /**
  * Archive Upload Mode Context Sync Example
@@ -57,10 +57,9 @@ async function archiveUploadModeExample(): Promise<void> {
     // Step 2: Configure sync policy with Archive upload mode
     console.log("\n⚙️  Step 2: Configuring sync policy with Archive upload mode...");
     const syncPolicy = newSyncPolicy();
-    syncPolicy.uploadPolicy!.uploadMode = "Archive"; // Set to Archive mode
-    
-    console.log(`✅ Sync policy configured with uploadMode: ${syncPolicy.uploadPolicy!.uploadMode}`);
+    syncPolicy.uploadPolicy!.uploadMode = UploadMode.Archive;
 
+    console.log(`✅ Sync policy configured with uploadMode: ${syncPolicy.uploadPolicy!.uploadMode}`);
     // Step 3: Create context sync configuration
     console.log("\n🔧 Step 3: Creating context sync configuration...");
     const contextSync = newContextSync(
@@ -76,7 +75,7 @@ async function archiveUploadModeExample(): Promise<void> {
 
     // Step 4: Create session with Archive mode context sync
     console.log("\n🏗️  Step 4: Creating session with Archive mode context sync...");
-    const sessionParams: CreateSessionParams = {
+    const sessionParams = {
       labels: {
         example: `archive-mode-${uniqueId}`,
         type: "archive-upload-demo",
@@ -173,7 +172,7 @@ async function archiveUploadModeExample(): Promise<void> {
     console.log("\n🎉 Archive upload mode example completed successfully!");
     console.log("✅ All operations completed without errors.");
 
-  } catch (error) {
+   } catch (error) {
     console.error("\n❌ Error occurred during example execution:");
     console.error(error);
   } finally {

package/docs/examples/common-features/basics/archive-upload-mode-example/README.md

@@ -48,7 +48,7 @@ const contextSync = newContextSync(
 ### Session Creation with Context Sync
 
 ```typescript
-const sessionParams: CreateSessionParams = {
+const sessionParams = {
   labels: {
     example: `archive-mode-${uniqueId}`,
     type: "archive-upload-demo",

package/docs/examples/common-features/basics/archive-upload-mode-example/main.ts

@@ -76,7 +76,7 @@ async function archiveUploadModeExample(): Promise<void> {
 
     // Step 4: Create session with Archive mode context sync
     console.log("\n🏗️  Step 4: Creating session with Archive mode context sync...");
-    const sessionParams: CreateSessionParams = {
+    const sessionParams = {
       labels: {
         example: `archive-mode-${uniqueId}`,
         type: "archive-upload-demo",

package/docs/examples/common-features/basics/filesystem-example/filesystem-example.ts

@@ -145,6 +145,19 @@ async function main() {
     } catch (error) {
       log(`Error moving file: ${error}`);
     }
+
+    // 9. Delete file
+    log(`\nDeleting file: ${newFilePath}`);
+    try {
+      const deleteResponse = await session.fileSystem.deleteFile(newFilePath);
+      log(`File deleted successfully: ${deleteResponse.success}`);
+      log(`Delete File RequestId: ${deleteResponse.requestId}`);
+
+      const infoAfterDelete = await session.fileSystem.getFileInfo(newFilePath);
+      log(`Get File Info After Delete: success=${infoAfterDelete.success}`);
+    } catch (error) {
+      log(`Error deleting file: ${error}`);
+    }
   } finally {
     // Clean up by deleting the session when we're done
     log('\nDeleting the session...');

package/docs/examples/common-features/basics/filesystem-example/filesystem-filetransfer-example.ts

@@ -30,7 +30,7 @@ async function main() {
     const createResponse = await agentBay.create({
       imageId: 'code_latest'
     });
-    
+
     if (!createResponse.success || !createResponse.session) {
       log(`Failed to create session: ${createResponse.errorMessage}`);
       return;
@@ -39,13 +39,12 @@ async function main() {
     const session = createResponse.session;
     log(`\nSession created with ID: ${session.sessionId}`);
     log(`Create Session RequestId: ${createResponse.requestId}`);
-    log(`Session fileTransferContextId: ${session.fileTransferContextId}`);
 
     try {
       // 1. Upload a file
       const remotePath = '/tmp/file_transfer_test/uploaded-file.txt';
       log(`\nUploading file from ${localUploadPath} to ${remotePath}`);
-      
+
       // Create the remote directory first
       const dirPath = path.dirname(remotePath);
       const createDirResult = await session.fileSystem.createDirectory(dirPath);
@@ -69,7 +68,7 @@ async function main() {
         log(`Bytes sent: ${uploadResult.bytesSent}`);
         log(`Request ID (upload URL): ${uploadResult.requestIdUploadUrl}`);
         log(`Request ID (sync): ${uploadResult.requestIdSync}`);
-        
+
         // Verify the file exists in remote location
         const listResult = await session.fileSystem.listDirectory(dirPath);
         if (listResult.success) {
@@ -87,7 +86,7 @@ async function main() {
       // 2. Create a file in the remote location for download
       const remoteDownloadPath = '/tmp/file_transfer_test/download-test.txt';
       const downloadContent = "This is a test file for AgentBay FileTransfer download functionality.\n".repeat(15);
-      
+
       log(`\nCreating remote file for download: ${remoteDownloadPath}`);
       const writeResult = await session.fileSystem.writeFile(remoteDownloadPath, downloadContent);
       if (writeResult.success) {
@@ -99,7 +98,7 @@ async function main() {
       // 3. Download the file
       const localDownloadPath = path.join(tempDir, 'downloaded-file.txt');
       log(`\nDownloading file from ${remoteDownloadPath} to ${localDownloadPath}`);
-      
+
       const downloadResult = await session.fileSystem.downloadFile(
         remoteDownloadPath,
         localDownloadPath,
@@ -115,7 +114,7 @@ async function main() {
         log(`Bytes received: ${downloadResult.bytesReceived}`);
         log(`Request ID (download URL): ${downloadResult.requestIdDownloadUrl}`);
         log(`Request ID (sync): ${downloadResult.requestIdSync}`);
-        
+
         // Verify downloaded file content
         const downloadedContent = fs.readFileSync(localDownloadPath, 'utf-8');
         if (downloadedContent === downloadContent) {

package/docs/examples/common-features/basics/filesystem-example/watch-directory-example.ts

@@ -25,7 +25,7 @@ async function main(): Promise<void> {
     console.log("✅ AgentBay client initialized");
 
     // Create session with code_latest ImageId
-    const sessionParams: CreateSessionParams = { imageId: "code_latest" };
+    const sessionParams = { imageId: "code_latest" };
     const sessionResult = await agentbay.create(sessionParams);
 
     if (!sessionResult.success) {

package/docs/examples/mobile-use/mobile-get-adb-url/index.ts

@@ -5,7 +5,7 @@
  * an ADB (Android Debug Bridge) connection URL for a mobile session.
  */
 
-import { AgentBay } from '@aliyun/wuying-agentbay-sdk';
+import { AgentBay } from 'wuying-agentbay-sdk';
 
 async function main() {
   // Get API key from environment variable

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "wuying-agentbay-sdk",
-    "version": "0.12.0",
+    "version": "0.13.0",
     "description": "TypeScript SDK for interacting with the Wuying AgentBay cloud runtime environment",
     "main": "./dist/index.cjs",
     "module": "./dist/index.mjs",
@@ -64,11 +64,11 @@
         "prettier": "^2.8.4",
         "sinon": "^15.2.0",
         "ts-jest": "^26.5.6",
-        "ts-node": "^10.9.2",
         "tsup": "^8.5.0",
-        "typedoc": "^0.25.0",
         "typedoc-plugin-markdown": "^3.16.0",
-        "typescript": "4.9.5"
+        "typescript": "^4.9.5",
+        "zod": "^3.25.76",
+        "zod-to-json-schema": "^3.22.4"
     },
     "dependencies": {
         "@alicloud/openapi-core": "^1.0.4",