wuying-agentbay-sdk 0.1.0

package/README.md

@@ -0,0 +1,122 @@
+# TypeScript SDK for Wuying AgentBay
+
+This directory contains the TypeScript implementation of the Wuying AgentBay SDK.
+
+## Prerequisites
+
+- Node.js (v14 or later)
+- npm (v6 or later)
+
+## Installation
+
+### For Development
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/aliyun/wuying-agentbay-sdk.git
+cd wuying-agentbay-sdk/typescript
+npm install
+```
+
+### For Usage in Your Project
+
+```bash
+npm install wuying-agentbay-sdk
+```
+
+## Development Scripts
+
+- **Build the project**:
+  ```bash
+  npm run build
+  ```
+
+- **Run tests**:
+  ```bash
+  npm test
+  ```
+
+- **Lint the code**:
+  ```bash
+  npm run lint
+  ```
+
+- **Format the code**:
+  ```bash
+  npm run format
+  ```
+
+## Running Examples
+
+You can run the example file using ts-node:
+
+```bash
+npx ts-node examples/basic-usage.ts
+```
+
+## TypeScript-Specific Usage
+
+```typescript
+import { AgentBay } from 'wuying-agentbay-sdk';
+
+async function main() {
+  // Initialize with API key
+  const agentBay = new AgentBay({ apiKey: 'your_api_key' });
+  
+  try {
+    // Create a session with labels
+    const session = await agentBay.create({
+      labels: {
+        purpose: 'demo',
+        environment: 'development'
+      }
+    });
+    log(`Session created with ID: ${session.sessionId}`);
+    
+    // Execute a command
+    const result = await session.command.executeCommand('ls -la');
+    log(`Command result: ${result}`);
+    
+    // Read a file
+    const content = await session.filesystem.readFile('/path/to/file.txt');
+    log(`File content: ${content}`);
+    
+    // Get installed applications
+    const apps = await session.application.getInstalledApps(true, false, true);
+    log(`Found ${apps.length} installed applications`);
+    
+    // List visible applications
+    const processes = await session.application.listVisibleApps();
+    log(`Found ${processes.length} visible applications`);
+    
+    // List root windows
+    const windows = await session.window.listRootWindows();
+    log(`Found ${windows.length} root windows`);
+    
+    // Get active window
+    const activeWindow = await session.window.getActiveWindow();
+    log(`Active window: ${activeWindow.title}`);
+    
+    // Get session labels
+    const labels = await session.getLabels();
+    log(`Session labels: ${JSON.stringify(labels)}`);
+    
+    // List sessions by labels
+    const filteredSessions = await agentBay.listByLabels({
+      purpose: 'demo'
+    });
+    log(`Found ${filteredSessions.length} matching sessions`);
+    
+    // Clean up
+    await agentBay.delete(session);
+    log('Session deleted successfully');
+  } catch (error) {
+    logError('Error:', error);
+  }
+}
+
+main();
+```
+
+For more detailed documentation, please refer to the main [README](../README.md) and [SDK Documentation](../docs/README.md) in the project root.

package/dist/src/adb/adb.d.ts

@@ -0,0 +1,20 @@
+import { Session } from '../session';
+/**
+ * Adb handles ADB operations in the AgentBay cloud environment.
+ */
+export declare class Adb {
+    private session;
+    /**
+     * Create a new Adb instance.
+     *
+     * @param session - The session to use for ADB operations
+     */
+    constructor(session: Session);
+    /**
+     * Execute an ADB shell command in the mobile environment.
+     *
+     * @param command - The ADB shell command to execute
+     * @returns The output of the ADB shell command
+     */
+    shell(command: string): Promise<string>;
+}

package/dist/src/adb/adb.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Adb = void 0;
+const model_1 = require("../api/models/model");
+/**
+ * Adb handles ADB operations in the AgentBay cloud environment.
+ */
+class Adb {
+    /**
+     * Create a new Adb instance.
+     *
+     * @param session - The session to use for ADB operations
+     */
+    constructor(session) {
+        this.session = session;
+    }
+    /**
+     * Execute an ADB shell command in the mobile environment.
+     *
+     * @param command - The ADB shell command to execute
+     * @returns The output of the ADB shell command
+     */
+    async shell(command) {
+        try {
+            const args = {
+                command
+            };
+            const callToolRequest = new model_1.CallMcpToolRequest({
+                authorization: `Bearer ${this.session.getAPIKey()}`,
+                sessionId: this.session.getSessionId(),
+                name: 'shell',
+                args: JSON.stringify(args)
+            });
+            const response = await this.session.getClient().callMcpTool(callToolRequest);
+            if (!response.body?.data) {
+                throw new Error('Invalid response data format');
+            }
+            // Extract content from response
+            const data = response.body.data;
+            if (!data.content || !Array.isArray(data.content)) {
+                throw new Error('Content field not found or not an array');
+            }
+            // Concatenate all text fields
+            let fullText = '';
+            for (const item of data.content) {
+                if (item && typeof item === 'object' && 'text' in item) {
+                    fullText += item.text + '\n';
+                }
+            }
+            return fullText;
+        }
+        catch (error) {
+            throw new Error(`Failed to execute ADB shell command: ${error}`);
+        }
+    }
+}
+exports.Adb = Adb;

package/dist/src/adb/index.d.ts

@@ -0,0 +1 @@
+export * from './adb';

package/dist/src/adb/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./adb"), exports);

package/dist/src/agent-bay.d.ts

@@ -0,0 +1,68 @@
+import { Session } from './session';
+import { ContextService } from './context';
+import Client from './api/client';
+import 'dotenv/config';
+/**
+ * Main class for interacting with the AgentBay cloud runtime environment.
+ */
+export declare class AgentBay {
+    private apiKey;
+    private client;
+    private regionId;
+    private endpoint;
+    private sessions;
+    /**
+     * Context service for managing persistent contexts.
+     */
+    context: ContextService;
+    /**
+     * Initialize the AgentBay client.
+     *
+     * @param options - Configuration options
+     * @param options.apiKey - API key for authentication. If not provided, will look for AGENTBAY_API_KEY environment variable.
+     */
+    constructor(options?: {
+        apiKey?: string;
+    });
+    /**
+     * Create a new session in the AgentBay cloud environment.
+     *
+     * @param options - Optional parameters for creating the session
+     * @param options.contextId - ID of the context to bind to the session
+     * @param options.labels - Custom labels for the session
+     * @returns A new Session object.
+     */
+    create(options?: {
+        contextId?: string;
+        labels?: Record<string, string>;
+        imageId?: string;
+    }): Promise<Session>;
+    /**
+     * List all available sessions.
+     *
+     * @returns A list of session objects.
+     */
+    list(): Session[];
+    /**
+     * List sessions filtered by the provided labels.
+     * It returns sessions that match all the specified labels.
+     *
+     * @param labels - The labels to filter by.
+     * @returns A list of session objects that match the labels.
+     */
+    listByLabels(labels: Record<string, string>): Promise<Session[]>;
+    /**
+     * Delete a session by ID.
+     *
+     * @param sessionId - The ID of the session to delete.
+     * @returns True if the session was successfully deleted.
+     */
+    delete(session: Session): Promise<boolean>;
+    /**
+     *
+     * @param sessionId - The ID of the session to remove.
+     */
+    removeSession(sessionId: string): void;
+    getClient(): Client;
+    getAPIKey(): string;
+}

package/dist/src/agent-bay.js

@@ -0,0 +1,213 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentBay = void 0;
+const session_1 = require("./session");
+const context_1 = require("./context");
+const exceptions_1 = require("./exceptions");
+const $_client = __importStar(require("./api"));
+const openapi_core_1 = require("@alicloud/openapi-core");
+const client_1 = __importDefault(require("./api/client"));
+const model_1 = require("./api/models/model");
+const config_1 = require("./config");
+require("dotenv/config");
+const logger_1 = require("./utils/logger");
+/**
+ * Main class for interacting with the AgentBay cloud runtime environment.
+ */
+class AgentBay {
+    /**
+     * Initialize the AgentBay client.
+     *
+     * @param options - Configuration options
+     * @param options.apiKey - API key for authentication. If not provided, will look for AGENTBAY_API_KEY environment variable.
+     */
+    constructor(options = {}) {
+        this.sessions = new Map();
+        this.apiKey = options.apiKey || process.env.AGENTBAY_API_KEY || '';
+        if (!this.apiKey) {
+            throw new exceptions_1.AuthenticationError('API key is required. Provide it as a parameter or set the AGENTBAY_API_KEY environment variable.');
+        }
+        // Load configuration
+        const configData = (0, config_1.loadConfig)();
+        this.regionId = configData.region_id;
+        this.endpoint = configData.endpoint;
+        const config = new openapi_core_1.$OpenApiUtil.Config({
+            regionId: this.regionId,
+            endpoint: this.endpoint
+        });
+        config.readTimeout = configData.timeout_ms;
+        config.connectTimeout = configData.timeout_ms;
+        try {
+            this.client = new client_1.default(config);
+            // Initialize context service
+            this.context = new context_1.ContextService(this);
+        }
+        catch (error) {
+            (0, logger_1.logError)(`Failed to constructor:`, error);
+            throw new exceptions_1.AuthenticationError(`Failed to constructor: ${error}`);
+        }
+    }
+    /**
+     * Create a new session in the AgentBay cloud environment.
+     *
+     * @param options - Optional parameters for creating the session
+     * @param options.contextId - ID of the context to bind to the session
+     * @param options.labels - Custom labels for the session
+     * @returns A new Session object.
+     */
+    async create(options = {}) {
+        try {
+            const createSessionRequest = new $_client.CreateMcpSessionRequest({
+                authorization: "Bearer " + this.apiKey,
+                imageId: options.imageId
+            });
+            // Add context_id if provided
+            if (options.contextId) {
+                createSessionRequest.contextId = options.contextId;
+            }
+            // Add labels if provided
+            if (options.labels) {
+                createSessionRequest.labels = JSON.stringify(options.labels);
+            }
+            // Log API request
+            (0, logger_1.log)("API Call: CreateMcpSession");
+            (0, logger_1.log)(`Request: ${options.contextId ? `ContextId=${options.contextId}, ` : ''}${options.labels ? `Labels=${JSON.stringify(options.labels)}, ` : ''}${options.imageId ? `ImageId=${options.imageId}` : ''}`);
+            const response = await this.client.createMcpSession(createSessionRequest);
+            // Log API response
+            (0, logger_1.log)(`Response from CreateMcpSession:`, response.body);
+            const sessionId = response.body?.data?.sessionId;
+            if (!sessionId) {
+                throw new exceptions_1.APIError('Invalid session ID in response');
+            }
+            // ResourceUrl is optional in CreateMcpSession response
+            const resourceUrl = response.body?.data?.resourceUrl;
+            const session = new session_1.Session(this, sessionId);
+            if (resourceUrl) {
+                session.resourceUrl = resourceUrl;
+            }
+            this.sessions.set(session.sessionId, session);
+            return session;
+        }
+        catch (error) {
+            (0, logger_1.logError)("Error calling CreateMcpSession:", error);
+            throw new exceptions_1.APIError(`Failed to create session: ${error}`);
+        }
+    }
+    /**
+     * List all available sessions.
+     *
+     * @returns A list of session objects.
+     */
+    list() {
+        return Array.from(this.sessions.values());
+    }
+    /**
+     * List sessions filtered by the provided labels.
+     * It returns sessions that match all the specified labels.
+     *
+     * @param labels - The labels to filter by.
+     * @returns A list of session objects that match the labels.
+     */
+    async listByLabels(labels) {
+        try {
+            // Convert labels to JSON
+            const labelsJSON = JSON.stringify(labels);
+            const listSessionRequest = new model_1.ListSessionRequest({
+                authorization: `Bearer ${this.apiKey}`,
+                labels: labelsJSON
+            });
+            // Log API request
+            (0, logger_1.log)("API Call: ListSession");
+            (0, logger_1.log)(`Request: Labels=${labelsJSON}`);
+            const response = await this.client.listSession(listSessionRequest);
+            // Log API response
+            (0, logger_1.log)(`Response from ListSession:`, response.body);
+            const sessions = [];
+            if (response.body?.data) {
+                for (const sessionData of response.body.data) {
+                    if (sessionData.sessionId) {
+                        const session = new session_1.Session(this, sessionData.sessionId);
+                        sessions.push(session);
+                        // Also store in the local cache
+                        this.sessions.set(sessionData.sessionId, session);
+                    }
+                }
+            }
+            return sessions;
+        }
+        catch (error) {
+            (0, logger_1.logError)("Error calling ListSession:", error);
+            throw new exceptions_1.APIError(`Failed to list sessions by labels: ${error}`);
+        }
+    }
+    /**
+     * Delete a session by ID.
+     *
+     * @param sessionId - The ID of the session to delete.
+     * @returns True if the session was successfully deleted.
+     */
+    async delete(session) {
+        const getSession = this.sessions.get(session.sessionId);
+        if (!getSession) {
+            throw new Error(`Session with ID ${session.sessionId} not found`);
+        }
+        try {
+            await session.delete();
+            return true;
+        }
+        catch (error) {
+            throw new exceptions_1.APIError(`Failed to delete session: ${error}`);
+        }
+    }
+    /**
+     *
+     * @param sessionId - The ID of the session to remove.
+     */
+    removeSession(sessionId) {
+        this.sessions.delete(sessionId);
+    }
+    // For internal use by the Session class
+    getClient() {
+        return this.client;
+    }
+    getAPIKey() {
+        return this.apiKey;
+    }
+}
+exports.AgentBay = AgentBay;

package/dist/src/api/client.d.ts

@@ -0,0 +1,191 @@
+import * as $dara from '@darabonba/typescript';
+import OpenApi from '@alicloud/openapi-core';
+import { $OpenApiUtil } from '@alicloud/openapi-core';
+import * as $_model from './models/model';
+export * from './models/model';
+export default class Client extends OpenApi {
+    constructor(config: $OpenApiUtil.Config);
+    getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
+        [key: string]: string;
+    }, endpoint: string): string;
+    /**
+     * 调用mcp工具
+     *
+     * @param request - CallMcpToolRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CallMcpToolResponse
+     */
+    callMcpToolWithOptions(request: $_model.CallMcpToolRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CallMcpToolResponse>;
+    /**
+     * 调用mcp工具
+     *
+     * @param request - CallMcpToolRequest
+     * @returns CallMcpToolResponse
+     */
+    callMcpTool(request: $_model.CallMcpToolRequest): Promise<$_model.CallMcpToolResponse>;
+    /**
+     * 创建 mcp session
+     *
+     * @param request - CreateMcpSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateMcpSessionResponse
+     */
+    createMcpSessionWithOptions(request: $_model.CreateMcpSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateMcpSessionResponse>;
+    /**
+     * 创建 mcp session
+     *
+     * @param request - CreateMcpSessionRequest
+     * @returns CreateMcpSessionResponse
+     */
+    createMcpSession(request: $_model.CreateMcpSessionRequest): Promise<$_model.CreateMcpSessionResponse>;
+    /**
+     * 删除持久化上下文
+     *
+     * @param request - DeleteContextRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteContextResponse
+     */
+    deleteContextWithOptions(request: $_model.DeleteContextRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteContextResponse>;
+    /**
+     * 删除持久化上下文
+     *
+     * @param request - DeleteContextRequest
+     * @returns DeleteContextResponse
+     */
+    deleteContext(request: $_model.DeleteContextRequest): Promise<$_model.DeleteContextResponse>;
+    /**
+     * 获取上下文
+     *
+     * @param request - GetContextRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetContextResponse
+     */
+    getContextWithOptions(request: $_model.GetContextRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetContextResponse>;
+    /**
+     * 获取上下文
+     *
+     * @param request - GetContextRequest
+     * @returns GetContextResponse
+     */
+    getContext(request: $_model.GetContextRequest): Promise<$_model.GetContextResponse>;
+    /**
+     * 获取标签
+     *
+     * @param request - GetLabelRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetLabelResponse
+     */
+    getLabelWithOptions(request: $_model.GetLabelRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetLabelResponse>;
+    /**
+     * 获取标签
+     *
+     * @param request - GetLabelRequest
+     * @returns GetLabelResponse
+     */
+    getLabel(request: $_model.GetLabelRequest): Promise<$_model.GetLabelResponse>;
+    /**
+     * 获取特定端口的转发链接
+     *
+     * @param request - GetLinkRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetLinkResponse
+     */
+    getLinkWithOptions(request: $_model.GetLinkRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetLinkResponse>;
+    /**
+     * 获取特定端口的转发链接
+     *
+     * @param request - GetLinkRequest
+     * @returns GetLinkResponse
+     */
+    getLink(request: $_model.GetLinkRequest): Promise<$_model.GetLinkResponse>;
+    /**
+     * 获取mcp资源信息
+     *
+     * @param request - GetMcpResourceRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetMcpResourceResponse
+     */
+    getMcpResourceWithOptions(request: $_model.GetMcpResourceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetMcpResourceResponse>;
+    /**
+     * 获取mcp资源信息
+     *
+     * @param request - GetMcpResourceRequest
+     * @returns GetMcpResourceResponse
+     */
+    getMcpResource(request: $_model.GetMcpResourceRequest): Promise<$_model.GetMcpResourceResponse>;
+    /**
+     * 获取上下文列表
+     *
+     * @param request - ListContextsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListContextsResponse
+     */
+    listContextsWithOptions(request: $_model.ListContextsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListContextsResponse>;
+    /**
+     * 获取上下文列表
+     *
+     * @param request - ListContextsRequest
+     * @returns ListContextsResponse
+     */
+    listContexts(request: $_model.ListContextsRequest): Promise<$_model.ListContextsResponse>;
+    /**
+     * 根据Lable查询Session列表
+     *
+     * @param request - ListSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListSessionResponse
+     */
+    listSessionWithOptions(request: $_model.ListSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSessionResponse>;
+    /**
+     * 根据Lable查询Session列表
+     *
+     * @param request - ListSessionRequest
+     * @returns ListSessionResponse
+     */
+    listSession(request: $_model.ListSessionRequest): Promise<$_model.ListSessionResponse>;
+    /**
+     * 修改上下文
+     *
+     * @param request - ModifyContextRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ModifyContextResponse
+     */
+    modifyContextWithOptions(request: $_model.ModifyContextRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyContextResponse>;
+    /**
+     * 修改上下文
+     *
+     * @param request - ModifyContextRequest
+     * @returns ModifyContextResponse
+     */
+    modifyContext(request: $_model.ModifyContextRequest): Promise<$_model.ModifyContextResponse>;
+    /**
+     * 释放 mcp session
+     *
+     * @param request - ReleaseMcpSessionRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ReleaseMcpSessionResponse
+     */
+    releaseMcpSessionWithOptions(request: $_model.ReleaseMcpSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ReleaseMcpSessionResponse>;
+    /**
+     * 释放 mcp session
+     *
+     * @param request - ReleaseMcpSessionRequest
+     * @returns ReleaseMcpSessionResponse
+     */
+    releaseMcpSession(request: $_model.ReleaseMcpSessionRequest): Promise<$_model.ReleaseMcpSessionResponse>;
+    /**
+     * 设置标签
+     *
+     * @param request - SetLabelRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns SetLabelResponse
+     */
+    setLabelWithOptions(request: $_model.SetLabelRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SetLabelResponse>;
+    /**
+     * 设置标签
+     *
+     * @param request - SetLabelRequest
+     * @returns SetLabelResponse
+     */
+    setLabel(request: $_model.SetLabelRequest): Promise<$_model.SetLabelResponse>;
+}