wuying-agentbay-sdk 0.8.0 → 0.9.1

package/README.md

@@ -24,6 +24,7 @@ async function main() {
     // Create session
     const agentBay = new AgentBay();
     const result = await agentBay.create();
+    // Verified: ✓ Client initialized and session created successfully
 
     if (result.success) {
         const session = result.session;
@@ -31,11 +32,15 @@ async function main() {
         // Execute command
         const cmdResult = await session.command.executeCommand("ls -la");
         console.log(cmdResult.output);
+        // Verified: ✓ Command executed successfully
+        // Sample output: "总计 100\ndrwxr-x--- 16 wuying wuying 4096..."
 
         // File operations
         await session.fileSystem.writeFile("/tmp/test.txt", "Hello World");
         const content = await session.fileSystem.readFile("/tmp/test.txt");
-        console.log(content.data);
+        console.log(content.content);
+        // Verified: ✓ File written and read successfully
+        // Output: "Hello World"
     }
 }
 
@@ -47,15 +52,20 @@ main().catch(console.error);
 ### 🆕 New Users
 - [📚 Quick Start Tutorial](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart/README.md) - Get started in 5 minutes
 - [🎯 Core Concepts](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart/basic-concepts.md) - Understanding cloud environments and sessions
-- [💡 Best Practices](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart/best-practices.md) - Common patterns and techniques
 
 ### 🚀 Experienced Users
+**Choose Your Cloud Environment:**
+- 🌐 [Browser Use](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/browser-use/README.md) - Web scraping, browser testing, form automation
+- 🖥️ [Computer Use](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/computer-use/README.md) - Windows desktop automation, UI testing
+- 📱 [Mobile Use](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/mobile-use/README.md) - Android UI testing, mobile app automation
+- 💻 [CodeSpace](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/codespace/README.md) - Code execution, development environments
+
+**Additional Resources:**
 - [📖 Feature Guides](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/README.md) - Complete feature introduction
 - [🔧 TypeScript API Reference](docs/api/README.md) - Detailed API documentation
-- [💻 TypeScript Examples](docs/examples/) - Complete example code
+- [💻 TypeScript Examples](docs/examples/README.md) - Complete example code
 
 ### 🆘 Need Help
-- [🔧 Troubleshooting](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart/troubleshooting.md) - Problem diagnosis
 - [🔧 TypeScript API Reference](docs/api/README.md) - Local API documentation
 - [💡 TypeScript Examples](docs/examples/README.md) - Local example code
 
@@ -65,12 +75,7 @@ main().catch(console.error);
 ```typescript
 // Create session
 const session = (await agentBay.create()).session;
-
-// List sessions
-const sessions = await agentBay.list();
-
-// Connect to existing session
-const session = await agentBay.connect("session_id");
+// Verified: ✓ Session created successfully
 ```
 
 ### File Operations
@@ -78,9 +83,12 @@ const session = await agentBay.connect("session_id");
 // Read and write files
 await session.fileSystem.writeFile("/path/file.txt", "content");
 const content = await session.fileSystem.readFile("/path/file.txt");
+// Verified: ✓ File operations work correctly
+// content.content contains the file's text content
 
 // List directory
 const files = await session.fileSystem.listDirectory("/path");
+// Verified: ✓ Returns list of file/directory information
 ```
 
 ### Command Execution
@@ -88,12 +96,15 @@ const files = await session.fileSystem.listDirectory("/path");
 // Execute command
 const result = await session.command.executeCommand("node script.js");
 console.log(result.output);
+// Verified: ✓ Command executed successfully
+// result.output contains the command's stdout
 ```
 
 ### Data Persistence
 ```typescript
 // Create context
 const context = (await agentBay.context.get("my-project", true)).context;
+// Verified: ✓ Context created or retrieved successfully
 
 // Create session with context
 import { ContextSync, SyncPolicy } from 'wuying-agentbay-sdk';
@@ -103,6 +114,8 @@ const contextSync = new ContextSync({
     policy: SyncPolicy.default()
 });
 const session = (await agentBay.create({ contextSync: [contextSync] })).session;
+// Verified: ✓ Session created with context synchronization
+// Data in /tmp/data will be synchronized to the context
 ```
 
 ## 🆘 Get Help
@@ -112,4 +125,4 @@ const session = (await agentBay.create({ contextSync: [contextSync] })).session;
 
 ## 📄 License
 
-This project is licensed under the Apache License 2.0 - see the [LICENSE](../LICENSE) file for details.
+This project is licensed under the Apache License 2.0 - see the [LICENSE](../LICENSE) file for details.

package/dist/chunk-HKUD6LHR.mjs

@@ -0,0 +1,612 @@
+
+        import { createRequire } from 'module';
+        const require = createRequire(import.meta.url);
+          (function() {
+            if (typeof OpenApi !== 'undefined' && !OpenApi.default) {
+              OpenApi.default = OpenApi;
+            }
+          })();
+        
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var __esm = (fn, res) => function __init() {
+  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __commonJS = (cb, mod) => function __require2() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// node_modules/tsup/assets/esm_shims.js
+import path from "path";
+import { fileURLToPath } from "url";
+var init_esm_shims = __esm({
+  "node_modules/tsup/assets/esm_shims.js"() {
+    "use strict";
+  }
+});
+
+// src/window/window.ts
+init_esm_shims();
+var _WindowManager = class _WindowManager {
+  /**
+   * Creates a new WindowManager instance.
+   * @param session The session object that provides access to the AgentBay API.
+   */
+  constructor(session) {
+    this.session = session;
+  }
+  /**
+   * Helper method to parse JSON string into Window objects
+   * @param jsonStr - JSON string to parse
+   * @returns Array of Window objects or single Window object
+   */
+  parseWindowsFromJSON(jsonStr) {
+    try {
+      const parsed = JSON.parse(jsonStr);
+      return Array.isArray(parsed) ? parsed : [parsed];
+    } catch (error) {
+      throw new Error(`Failed to parse window data: ${error}`);
+    }
+  }
+  /**
+   * Lists all root windows in the system.
+   * Corresponds to Python's list_root_windows() method
+   *
+   * @param timeoutMs - The timeout in milliseconds. Default is 3000ms.
+   * @returns WindowListResult with windows array and requestId
+   * 
+   * @deprecated Use session.computer.listRootWindows() instead.
+   */
+  async listRootWindows(timeoutMs = 3e3) {
+    console.warn("\u26A0\uFE0F  WindowManager.listRootWindows() is deprecated. Use session.computer.listRootWindows() instead.");
+    try {
+      const args = {
+        timeout_ms: timeoutMs
+      };
+      const response = await this.session.callMcpTool(
+        "list_root_windows",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          windows: [],
+          errorMessage: response.errorMessage
+        };
+      }
+      const windows = response.data ? this.parseWindowsFromJSON(response.data) : [];
+      return {
+        requestId: response.requestId,
+        success: true,
+        windows
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        windows: [],
+        errorMessage: `Failed to list root windows: ${error}`
+      };
+    }
+  }
+  /**
+   * Lists all windows in the system.
+   * Corresponds to Python's list_all_windows() method
+   *
+   * @param timeoutMs - The timeout in milliseconds. Default is 3000ms.
+   * @returns WindowListResult with windows array and requestId
+   * 
+   * @deprecated Use session.computer.listAllWindows() instead.
+   */
+  async listAllWindows(timeoutMs = 3e3) {
+    console.warn("\u26A0\uFE0F  WindowManager.listAllWindows() is deprecated. Use session.computer.listAllWindows() instead.");
+    try {
+      const args = {
+        timeout_ms: timeoutMs
+      };
+      const response = await this.session.callMcpTool(
+        "list_all_windows",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          windows: [],
+          errorMessage: response.errorMessage
+        };
+      }
+      const windows = response.data ? this.parseWindowsFromJSON(response.data) : [];
+      return {
+        requestId: response.requestId,
+        success: true,
+        windows
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        windows: [],
+        errorMessage: `Failed to list all windows: ${error}`
+      };
+    }
+  }
+  /**
+   * Gets information about a specific window.
+   * Corresponds to Python's get_window_info() method
+   *
+   * @param windowId - The ID of the window to get information for.
+   * @returns WindowInfoResult with window information and requestId
+   * 
+   * @deprecated Use session.computer.getWindowInfo() instead.
+   */
+  async getWindowInfo(windowId) {
+    console.warn("\u26A0\uFE0F  WindowManager.getWindowInfo() is deprecated. Use session.computer.getWindowInfo() instead.");
+    try {
+      const args = {
+        window_id: windowId
+      };
+      const response = await this.session.callMcpTool(
+        "get_window_info",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      let window = void 0;
+      if (response.data) {
+        const windows = this.parseWindowsFromJSON(response.data);
+        window = windows.length > 0 ? windows[0] : void 0;
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        window
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to get window info: ${error}`
+      };
+    }
+  }
+  /**
+   * Activates a window by bringing it to the foreground.
+   * Corresponds to Python's activate_window() method
+   *
+   * @param windowId - The ID of the window to activate.
+   * @returns BoolResult with success status and requestId
+   * 
+   * @deprecated Use session.computer.activateWindow() instead.
+   */
+  async activateWindow(windowId) {
+    console.warn("\u26A0\uFE0F  WindowManager.activateWindow() is deprecated. Use session.computer.activateWindow() instead.");
+    try {
+      const args = {
+        window_id: windowId
+      };
+      const response = await this.session.callMcpTool(
+        "activate_window",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        data: true
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to activate window: ${error}`
+      };
+    }
+  }
+  /**
+   * Maximizes a window.
+   * Corresponds to Python's maximize_window() method
+   *
+   * @param windowId - The ID of the window to maximize.
+   * @returns BoolResult with success status and requestId
+   * 
+   * @deprecated Use session.computer.maximizeWindow() instead.
+   */
+  async maximizeWindow(windowId) {
+    console.warn("\u26A0\uFE0F  WindowManager.maximizeWindow() is deprecated. Use session.computer.maximizeWindow() instead.");
+    try {
+      const args = {
+        window_id: windowId
+      };
+      const response = await this.session.callMcpTool(
+        "maximize_window",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        data: true
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to maximize window: ${error}`
+      };
+    }
+  }
+  /**
+   * Minimizes a window.
+   * Corresponds to Python's minimize_window() method
+   *
+   * @param windowId - The ID of the window to minimize.
+   * @returns BoolResult with success status and requestId
+   * 
+   * @deprecated Use session.computer.minimizeWindow() instead.
+   */
+  async minimizeWindow(windowId) {
+    console.warn("\u26A0\uFE0F  WindowManager.minimizeWindow() is deprecated. Use session.computer.minimizeWindow() instead.");
+    try {
+      const args = {
+        window_id: windowId
+      };
+      const response = await this.session.callMcpTool(
+        "minimize_window",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        data: true
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to minimize window: ${error}`
+      };
+    }
+  }
+  /**
+   * Restores a window by ID.
+   * Corresponds to Python's restore_window() method
+   *
+   * @param windowId The ID of the window to restore.
+   * @returns BoolResult with requestId
+   */
+  async restoreWindow(windowId) {
+    try {
+      const args = {
+        window_id: windowId
+      };
+      const response = await this.session.callMcpTool(
+        "restore_window",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        data: true
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to restore window: ${error}`
+      };
+    }
+  }
+  /**
+   * Closes a window.
+   * Corresponds to Python's close_window() method
+   *
+   * @param windowId - The ID of the window to close.
+   * @returns BoolResult with success status and requestId
+   * 
+   * @deprecated Use session.computer.closeWindow() instead.
+   */
+  async closeWindow(windowId) {
+    console.warn("\u26A0\uFE0F  WindowManager.closeWindow() is deprecated. Use session.computer.closeWindow() instead.");
+    try {
+      const args = {
+        window_id: windowId
+      };
+      const response = await this.session.callMcpTool(
+        "close_window",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        data: true
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to close window: ${error}`
+      };
+    }
+  }
+  /**
+   * Sets a window to fullscreen by ID.
+   * Corresponds to Python's fullscreen_window() method
+   *
+   * @param windowId The ID of the window to set to fullscreen.
+   * @returns BoolResult with requestId
+   */
+  async fullscreenWindow(windowId) {
+    try {
+      const args = {
+        window_id: windowId
+      };
+      const response = await this.session.callMcpTool(
+        "fullscreen_window",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        data: true
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to make window fullscreen: ${error}`
+      };
+    }
+  }
+  /**
+   * Resizes a window to the specified dimensions.
+   * Corresponds to Python's resize_window() method
+   *
+   * @param windowId - The ID of the window to resize.
+   * @param width - The new width of the window.
+   * @param height - The new height of the window.
+   * @returns BoolResult with success status and requestId
+   * 
+   * @deprecated Use session.computer.resizeWindow() instead.
+   */
+  async resizeWindow(windowId, width, height) {
+    console.warn("\u26A0\uFE0F  WindowManager.resizeWindow() is deprecated. Use session.computer.resizeWindow() instead.");
+    try {
+      const args = {
+        window_id: windowId,
+        width,
+        height
+      };
+      const response = await this.session.callMcpTool(
+        "resize_window",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        data: true
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to resize window: ${error}`
+      };
+    }
+  }
+  /**
+   * Moves a window to the specified position.
+   * Corresponds to Python's move_window() method
+   *
+   * @param windowId - The ID of the window to move.
+   * @param x - The new x coordinate of the window.
+   * @param y - The new y coordinate of the window.
+   * @returns BoolResult with success status and requestId
+   * 
+   * @deprecated Use session.computer.moveWindow() instead.
+   */
+  async moveWindow(windowId, x, y) {
+    console.warn("\u26A0\uFE0F  WindowManager.moveWindow() is deprecated. Use session.computer.moveWindow() instead.");
+    try {
+      const args = {
+        window_id: windowId,
+        x,
+        y
+      };
+      const response = await this.session.callMcpTool(
+        "move_window",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        data: true
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to move window: ${error}`
+      };
+    }
+  }
+  /**
+   * Enables or disables focus mode.
+   * Corresponds to Python's focus_mode() method
+   *
+   * @param on Whether to enable focus mode.
+   * @returns BoolResult with requestId
+   */
+  async focusMode(on) {
+    try {
+      const args = {
+        on
+      };
+      const response = await this.session.callMcpTool(
+        "focus_mode",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        data: true
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to toggle focus mode: ${error}`
+      };
+    }
+  }
+  /**
+   * Gets the currently active window.
+   * Corresponds to Python's get_active_window() method
+   *
+   * @param timeoutMs - The timeout in milliseconds. Default is 3000ms.
+   * @returns WindowInfoResult with active window information and requestId
+   * 
+   * @deprecated Use session.computer.getActiveWindow() instead.
+   */
+  async getActiveWindow(timeoutMs = 3e3) {
+    console.warn("\u26A0\uFE0F  WindowManager.getActiveWindow() is deprecated. Use session.computer.getActiveWindow() instead.");
+    try {
+      const args = {
+        timeout_ms: timeoutMs
+      };
+      const response = await this.session.callMcpTool(
+        "get_active_window",
+        args
+      );
+      if (!response.success) {
+        return {
+          requestId: response.requestId,
+          success: false,
+          errorMessage: response.errorMessage
+        };
+      }
+      let activeWindow = void 0;
+      if (response.data) {
+        const windows = this.parseWindowsFromJSON(response.data);
+        activeWindow = windows.length > 0 ? windows[0] : void 0;
+      }
+      return {
+        requestId: response.requestId,
+        success: true,
+        window: activeWindow
+      };
+    } catch (error) {
+      return {
+        requestId: "",
+        success: false,
+        errorMessage: `Failed to get active window: ${error}`
+      };
+    }
+  }
+};
+__name(_WindowManager, "WindowManager");
+var WindowManager = _WindowManager;
+
+export {
+  __name,
+  __require,
+  __commonJS,
+  __toESM,
+  init_esm_shims,
+  WindowManager
+};
+//# sourceMappingURL=chunk-HKUD6LHR.mjs.map