wuying-agentbay-sdk 0.10.2 → 0.12.0

package/dist/model-LGWQJWKQ.mjs

@@ -0,0 +1,209 @@
+
+        import { createRequire } from 'module';
+        const require = createRequire(import.meta.url);
+          (function() {
+            if (typeof OpenApi !== 'undefined' && !OpenApi.default) {
+              OpenApi.default = OpenApi;
+            }
+          })();
+        
+import {
+  ApplyMqttTokenRequest,
+  ApplyMqttTokenResponse,
+  ApplyMqttTokenResponseBody,
+  ApplyMqttTokenResponseBodyData,
+  CallMcpToolRequest,
+  CallMcpToolResponse,
+  CallMcpToolResponseBody,
+  ClearContextRequest,
+  ClearContextResponse,
+  ClearContextResponseBody,
+  CreateMcpSessionRequest,
+  CreateMcpSessionRequestPersistenceDataList,
+  CreateMcpSessionResponse,
+  CreateMcpSessionResponseBody,
+  CreateMcpSessionResponseBodyData,
+  CreateMcpSessionShrinkRequest,
+  DeleteContextFileRequest,
+  DeleteContextFileResponse,
+  DeleteContextFileResponseBody,
+  DeleteContextRequest,
+  DeleteContextResponse,
+  DeleteContextResponseBody,
+  DescribeContextFilesRequest,
+  DescribeContextFilesResponse,
+  DescribeContextFilesResponseBody,
+  GetAdbLinkRequest,
+  GetAdbLinkResponse,
+  GetAdbLinkResponseBody,
+  GetAdbLinkResponseBodyData,
+  GetCdpLinkRequest,
+  GetCdpLinkResponse,
+  GetCdpLinkResponseBody,
+  GetCdpLinkResponseBodyData,
+  GetContextFileDownloadUrlRequest,
+  GetContextFileDownloadUrlResponse,
+  GetContextFileDownloadUrlResponseBody,
+  GetContextFileUploadUrlRequest,
+  GetContextFileUploadUrlResponse,
+  GetContextFileUploadUrlResponseBody,
+  GetContextInfoRequest,
+  GetContextInfoResponse,
+  GetContextInfoResponseBody,
+  GetContextInfoResponseBodyData,
+  GetContextRequest,
+  GetContextResponse,
+  GetContextResponseBody,
+  GetContextResponseBodyData,
+  GetLabelRequest,
+  GetLabelResponse,
+  GetLabelResponseBody,
+  GetLabelResponseBodyData,
+  GetLinkRequest,
+  GetLinkResponse,
+  GetLinkResponseBody,
+  GetLinkResponseBodyData,
+  GetMcpResourceRequest,
+  GetMcpResourceResponse,
+  GetMcpResourceResponseBody,
+  GetMcpResourceResponseBodyData,
+  GetMcpResourceResponseBodyDataDesktopInfo,
+  GetSessionRequest,
+  GetSessionResponse,
+  GetSessionResponseBody,
+  GetSessionResponseBodyData,
+  InitBrowserRequest,
+  InitBrowserResponse,
+  InitBrowserResponseBody,
+  InitBrowserResponseBodyData,
+  ListContextsRequest,
+  ListContextsResponse,
+  ListContextsResponseBody,
+  ListContextsResponseBodyData,
+  ListMcpToolsRequest,
+  ListMcpToolsResponse,
+  ListMcpToolsResponseBody,
+  ListSessionRequest,
+  ListSessionResponse,
+  ListSessionResponseBody,
+  ListSessionResponseBodyData,
+  ModifyContextRequest,
+  ModifyContextResponse,
+  ModifyContextResponseBody,
+  PauseSessionAsyncRequest,
+  PauseSessionAsyncResponse,
+  PauseSessionAsyncResponseBody,
+  ReleaseMcpSessionRequest,
+  ReleaseMcpSessionResponse,
+  ReleaseMcpSessionResponseBody,
+  ResumeSessionAsyncRequest,
+  ResumeSessionAsyncResponse,
+  ResumeSessionAsyncResponseBody,
+  SetLabelRequest,
+  SetLabelResponse,
+  SetLabelResponseBody,
+  SyncContextRequest,
+  SyncContextResponse,
+  SyncContextResponseBody
+} from "./chunk-BVWUCG4J.mjs";
+import "./chunk-KNEDRAP6.mjs";
+export {
+  ApplyMqttTokenRequest,
+  ApplyMqttTokenResponse,
+  ApplyMqttTokenResponseBody,
+  ApplyMqttTokenResponseBodyData,
+  CallMcpToolRequest,
+  CallMcpToolResponse,
+  CallMcpToolResponseBody,
+  ClearContextRequest,
+  ClearContextResponse,
+  ClearContextResponseBody,
+  CreateMcpSessionRequest,
+  CreateMcpSessionRequestPersistenceDataList,
+  CreateMcpSessionResponse,
+  CreateMcpSessionResponseBody,
+  CreateMcpSessionResponseBodyData,
+  CreateMcpSessionShrinkRequest,
+  DeleteContextFileRequest,
+  DeleteContextFileResponse,
+  DeleteContextFileResponseBody,
+  DeleteContextRequest,
+  DeleteContextResponse,
+  DeleteContextResponseBody,
+  DescribeContextFilesRequest,
+  DescribeContextFilesResponse,
+  DescribeContextFilesResponseBody,
+  GetAdbLinkRequest,
+  GetAdbLinkResponse,
+  GetAdbLinkResponseBody,
+  GetAdbLinkResponseBodyData,
+  GetCdpLinkRequest,
+  GetCdpLinkResponse,
+  GetCdpLinkResponseBody,
+  GetCdpLinkResponseBodyData,
+  GetContextFileDownloadUrlRequest,
+  GetContextFileDownloadUrlResponse,
+  GetContextFileDownloadUrlResponseBody,
+  GetContextFileUploadUrlRequest,
+  GetContextFileUploadUrlResponse,
+  GetContextFileUploadUrlResponseBody,
+  GetContextInfoRequest,
+  GetContextInfoResponse,
+  GetContextInfoResponseBody,
+  GetContextInfoResponseBodyData,
+  GetContextRequest,
+  GetContextResponse,
+  GetContextResponseBody,
+  GetContextResponseBodyData,
+  GetLabelRequest,
+  GetLabelResponse,
+  GetLabelResponseBody,
+  GetLabelResponseBodyData,
+  GetLinkRequest,
+  GetLinkResponse,
+  GetLinkResponseBody,
+  GetLinkResponseBodyData,
+  GetMcpResourceRequest,
+  GetMcpResourceResponse,
+  GetMcpResourceResponseBody,
+  GetMcpResourceResponseBodyData,
+  GetMcpResourceResponseBodyDataDesktopInfo,
+  GetSessionRequest,
+  GetSessionResponse,
+  GetSessionResponseBody,
+  GetSessionResponseBodyData,
+  InitBrowserRequest,
+  InitBrowserResponse,
+  InitBrowserResponseBody,
+  InitBrowserResponseBodyData,
+  ListContextsRequest,
+  ListContextsResponse,
+  ListContextsResponseBody,
+  ListContextsResponseBodyData,
+  ListMcpToolsRequest,
+  ListMcpToolsResponse,
+  ListMcpToolsResponseBody,
+  ListSessionRequest,
+  ListSessionResponse,
+  ListSessionResponseBody,
+  ListSessionResponseBodyData,
+  ModifyContextRequest,
+  ModifyContextResponse,
+  ModifyContextResponseBody,
+  PauseSessionAsyncRequest,
+  PauseSessionAsyncResponse,
+  PauseSessionAsyncResponseBody,
+  ReleaseMcpSessionRequest,
+  ReleaseMcpSessionResponse,
+  ReleaseMcpSessionResponseBody,
+  ResumeSessionAsyncRequest,
+  ResumeSessionAsyncResponse,
+  ResumeSessionAsyncResponseBody,
+  SetLabelRequest,
+  SetLabelResponse,
+  SetLabelResponseBody,
+  SyncContextRequest,
+  SyncContextResponse,
+  SyncContextResponseBody
+};
+//# sourceMappingURL=model-LGWQJWKQ.mjs.map

package/docs/api/README.md

@@ -0,0 +1,26 @@
+# TypeScript SDK API Reference
+
+These documents are generated automatically using TypeDoc. Run `npm run docs:generate` to refresh them after changing the SDK.
+
+## Structure
+- `browser-use`
+  - browser.md
+  - extension.md
+- `codespace`
+  - code.md
+- `common-features/advanced`
+  - agent.md
+  - oss.md
+- `common-features/basics`
+  - agentbay.md
+  - command.md
+  - context-manager.md
+  - context-sync.md
+  - context.md
+  - filesystem.md
+  - logging.md
+  - session.md
+- `computer-use`
+  - computer.md
+- `mobile-use`
+  - mobile.md

package/docs/api/browser-use/browser.md

@@ -0,0 +1,177 @@
+# Class: Browser
+
+## 🌐 Related Tutorial
+
+- [Browser Use Guide](../../../../docs/guides/browser-use/README.md) - Complete guide to browser automation
+
+## Overview
+
+The Browser module provides comprehensive browser automation capabilities including navigation, element interaction,
+screenshot capture, and content extraction. It enables automated testing and web scraping workflows.
+
+
+## Requirements
+
+- Requires `browser_latest` image for browser automation features
+
+## Table of contents
+
+
+### Properties
+
+
+### Methods
+
+- [destroy](#destroy)
+- [initialize](#initialize)
+- [initializeAsync](#initializeasync)
+- [isInitialized](#isinitialized)
+- [screenshot](#screenshot)
+
+## Properties
+
+```typescript
+agent: ``BrowserAgent``
+```
+
+
+## Methods
+
+### destroy
+
+▸ **destroy**(): `Promise`\<`void`\>
+
+Destroy the browser instance.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+### initialize
+
+▸ **initialize**(`option`): `boolean`
+
+Initialize the browser instance with the given options.
+Returns true if successful, false otherwise.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `option` | ``BrowserOption`` \| ``BrowserOptionClass`` |
+
+#### Returns
+
+`boolean`
+
+___
+
+### initializeAsync
+
+▸ **initializeAsync**(`option`): `Promise`\<`boolean`\>
+
+Initialize the browser instance with the given options asynchronously.
+Returns true if successful, false otherwise.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `option` | ``BrowserOption`` \| ``BrowserOptionClass`` | Browser configuration options |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise resolving to true if successful, false otherwise
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: process.env.AGENTBAY_API_KEY });
+const result = await agentBay.create({ imageId: 'browser_latest' });
+if (result.success) {
+  const success = await result.session.browser.initializeAsync(new BrowserOptionClass());
+  console.log('Browser initialized:', success);
+  await result.session.delete();
+}
+```
+
+___
+
+### isInitialized
+
+▸ **isInitialized**(): `boolean`
+
+Returns true if the browser was initialized, false otherwise.
+
+#### Returns
+
+`boolean`
+
+___
+
+### screenshot
+
+▸ **screenshot**(`page`, `fullPage?`, `options?`): `Promise`\<`Uint8Array`\>
+
+Takes a screenshot of the specified page with enhanced options and error handling.
+This method requires the caller to connect to the browser via Playwright or similar
+and pass the page object to this method.
+
+Note: This is a placeholder method that indicates where screenshot functionality
+should be implemented. In a complete implementation, this would use Playwright's
+page.screenshot() method or similar browser automation API.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `page` | `any` | `undefined` | The Playwright Page object to take a screenshot of. This is a required parameter. |
+| `fullPage` | `boolean` | `false` | Whether to capture the full scrollable page. Defaults to false. |
+| `options` | `Record`\<`string`, `any`\> | `{}` | Additional screenshot options that will override defaults. Common options include: - type: Image type, either 'png' or 'jpeg' (default: 'png') - quality: Quality of the image, between 0-100 (jpeg only) - timeout: Maximum time in milliseconds (default: 60000) - animations: How to handle animations (default: 'disabled') - caret: How to handle the caret (default: 'hide') - scale: Scale setting (default: 'css') |
+
+#### Returns
+
+`Promise`\<`Uint8Array`\>
+
+Screenshot data as Uint8Array.
+
+**`Throws`**
+
+BrowserError If browser is not initialized.
+
+**`Throws`**
+
+Error If screenshot capture fails.
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: process.env.AGENTBAY_API_KEY });
+const result = await agentBay.create({ imageId: 'browser_latest' });
+if (result.success) {
+  await result.session.browser.initializeAsync(new BrowserOptionClass());
+  const browser = await chromium.connectOverCDP(await result.session.browser.getEndpointUrl());
+  const page = await browser.contexts()[0].newPage();
+  await page.goto('https://example.com');
+  const screenshot = await result.session.browser.screenshot(page);
+  await writeFile('screenshot.png', Buffer.from(screenshot));
+  await browser.close();
+  await result.session.delete();
+}
+```
+
+## Best Practices
+
+1. Wait for page load completion before interacting with elements
+2. Use appropriate selectors (CSS, XPath) for reliable element identification
+3. Handle navigation timeouts and errors gracefully
+4. Take screenshots for debugging and verification
+5. Clean up browser resources after automation tasks
+
+
+## Related Resources
+
+- [Session API Reference](../common-features/basics/session.md)
+

package/docs/api/browser-use/extension.md

@@ -0,0 +1,284 @@
+# Class: ExtensionsService
+
+## 🧩 Related Tutorial
+
+- [Browser Extensions Guide](../../../../docs/guides/browser-use/core-features/extension.md) - Learn how to use browser extensions
+
+Provides methods to manage user browser extensions.
+This service integrates with the existing context functionality for file operations.
+
+**Usage** (Simplified - Auto-detection):
+```typescript
+// Service automatically detects if context exists and creates if needed
+const extensionsService = new ExtensionsService(agentBay, "browser_extensions");
+
+// Or use with empty contextId to auto-generate context name
+const extensionsService = new ExtensionsService(agentBay);  // Uses default generated name
+
+// Use the service immediately - initialization happens automatically
+const extension = await extensionsService.create("/path/to/plugin.zip");
+```
+
+**Integration with ExtensionOption (Simplified)**:
+```typescript
+// Create extensions and configure for browser sessions
+const extensionsService = new ExtensionsService(agentBay, "my_extensions");
+const ext1 = await extensionsService.create("/path/to/ext1.zip");
+const ext2 = await extensionsService.create("/path/to/ext2.zip");
+
+// Create extension option for browser integration (no contextId needed!)
+const extOption = extensionsService.createExtensionOption([ext1.id, ext2.id]);
+
+// Use with BrowserContext for session creation
+const browserContext = new BrowserContext({
+  contextId: "browser_session",
+  autoUpload: true,
+  extensionOption: extOption  // All extension config encapsulated
+});
+```
+
+**Context Management**:
+- If contextId provided and exists: Uses the existing context
+- If contextId provided but doesn't exist: Creates context with provided name
+- If contextId empty or not provided: Generates default name and creates context
+- No need to manually manage context creation or call initialize()
+- Context initialization happens automatically on first method call
+
+## Table of contents
+
+
+### Methods
+
+- [cleanup](#cleanup)
+- [create](#create)
+- [createExtensionOption](#createextensionoption)
+- [delete](#delete)
+- [list](#list)
+- [update](#update)
+
+## Methods
+
+### cleanup
+
+▸ **cleanup**(): `Promise`\<`boolean`\>
+
+Cleans up the auto-created context if it was created by this service.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise that resolves to true if cleanup was successful or not needed, false if cleanup failed.
+
+Note:
+  This method only works if the context was auto-created by this service.
+  For existing contexts, no cleanup is performed.
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: 'your_api_key' });
+const service = new ExtensionsService(agentBay);
+await service.create('/path/to/my-extension.zip');
+const success = await service.cleanup();
+console.log('Cleanup success:', success);
+```
+
+___
+
+### create
+
+▸ **create**(`localPath`): `Promise`\<``Extension``\>
+
+Uploads a new browser extension from a local path into the current context.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `localPath` | `string` | Path to the local extension file (must be a .zip file). |
+
+#### Returns
+
+`Promise`\<``Extension``\>
+
+Promise that resolves to an Extension object.
+
+**`Throws`**
+
+If the local file doesn't exist.
+
+**`Throws`**
+
+If the file format is not supported (only .zip is supported).
+
+**`Throws`**
+
+If upload fails.
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: 'your_api_key' });
+const service = new ExtensionsService(agentBay);
+const extension = await service.create('/path/to/my-extension.zip');
+console.log(`Extension ID: ${extension.id}`);
+await service.cleanup();
+```
+
+___
+
+### createExtensionOption
+
+▸ **createExtensionOption**(`extensionIds`): ``ExtensionOption``
+
+Create an ExtensionOption for the current context with specified extension IDs.
+
+This is a convenience method that creates an ExtensionOption using the current
+service's contextId and the provided extension IDs. This option can then be
+used with BrowserContext for browser session creation.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `extensionIds` | `string`[] | List of extension IDs to include in the option. These should be extensions that exist in the current context. |
+
+#### Returns
+
+``ExtensionOption``
+
+ExtensionOption configuration object for browser extension integration.
+
+**`Throws`**
+
+If extensionIds is empty or invalid.
+
+**`Example`**
+
+```typescript
+// Create extensions
+const ext1 = await extensionsService.create("/path/to/ext1.zip");
+const ext2 = await extensionsService.create("/path/to/ext2.zip");
+
+// Create extension option for browser integration
+const extOption = extensionsService.createExtensionOption([ext1.id, ext2.id]);
+
+// Use with BrowserContext
+const browserContext = new BrowserContext({
+  contextId: "browser_session",
+  autoUpload: true,
+  extensionContextId: extOption.contextId,
+  extensionIds: extOption.extensionIds
+});
+```
+
+___
+
+### delete
+
+▸ **delete**(`extensionId`): `Promise`\<`boolean`\>
+
+Deletes a browser extension from the current context.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `extensionId` | `string` | ID of the extension to delete. |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise that resolves to true if deletion was successful, false otherwise.
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: 'your_api_key' });
+const service = new ExtensionsService(agentBay, 'my_extensions');
+const ext = await service.create('/path/to/my-extension.zip');
+const success = await service.delete(ext.id);
+console.log('Delete success:', success);
+await service.cleanup();
+```
+
+___
+
+### list
+
+▸ **list**(): `Promise`\<``Extension``[]\>
+
+Lists all available browser extensions within this context from the cloud.
+Uses the context service to list files under the extensions directory.
+
+#### Returns
+
+`Promise`\<``Extension``[]\>
+
+Promise that resolves to an array of Extension objects.
+
+**`Throws`**
+
+If listing extensions fails.
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: 'your_api_key' });
+const service = new ExtensionsService(agentBay, 'my_extensions');
+await service.create('/path/to/ext1.zip');
+const extensions = await service.list();
+console.log(`Found ${extensions.length} extensions`);
+await service.cleanup();
+```
+
+___
+
+### update
+
+▸ **update**(`extensionId`, `newLocalPath`): `Promise`\<``Extension``\>
+
+Updates an existing browser extension in the current context with a new file.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `extensionId` | `string` | ID of the extension to update. |
+| `newLocalPath` | `string` | Path to the new local extension file. |
+
+#### Returns
+
+`Promise`\<``Extension``\>
+
+Promise that resolves to an Extension object.
+
+**`Throws`**
+
+If the new local file doesn't exist.
+
+**`Throws`**
+
+If the extension doesn't exist in the context.
+
+**`Throws`**
+
+If update fails.
+
+**`Example`**
+
+```typescript
+const agentBay = new AgentBay({ apiKey: 'your_api_key' });
+const service = new ExtensionsService(agentBay, 'my_extensions');
+const ext = await service.create('/path/to/ext-v1.zip');
+const updated = await service.update(ext.id, '/path/to/ext-v2.zip');
+console.log('Extension updated:', updated.name);
+await service.cleanup();
+```
+
+## Related Resources
+
+- [Browser API Reference](browser.md)
+