test-wuying-agentbay-sdk 0.13.0-beta.20251211155407 → 0.13.0-beta.20251211205534

package/docs/api/README.md

@@ -4,8 +4,10 @@ These documents are generated automatically using TypeDoc. Run `npm run docs:gen
 
 ## Structure
 - `browser-use`
+  - browser-agent.md
   - browser.md
   - extension.md
+  - fingerprint.md
 - `codespace`
   - code.md
 - `common-features/advanced`
@@ -21,8 +23,10 @@ These documents are generated automatically using TypeDoc. Run `npm run docs:gen
   - context.md
   - filesystem.md
   - logging.md
+  - session-params.md
   - session.md
 - `computer-use`
   - computer.md
 - `mobile-use`
+  - mobile-simulate.md
   - mobile.md

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

@@ -0,0 +1,133 @@
+# Class: BrowserAgent
+
+## Table of contents
+
+
+### Methods
+
+- [act](#act)
+- [actAsync](#actasync)
+- [extract](#extract)
+- [extractAsync](#extractasync)
+- [observe](#observe)
+- [observeAsync](#observeasync)
+
+## Methods
+
+### act
+
+▸ **act**(`options`, `page`): `Promise`\<``ActResult``\>
+
+------------------ ACT ------------------ *
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | ``ActOptions`` |
+| `page` | `any` |
+
+#### Returns
+
+`Promise`\<``ActResult``\>
+
+___
+
+### actAsync
+
+▸ **actAsync**(`options`, `page`): `Promise`\<``ActResult``\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | ``ActOptions`` |
+| `page` | `any` |
+
+#### Returns
+
+`Promise`\<``ActResult``\>
+
+___
+
+### extract
+
+▸ **extract**\<`T`\>(`options`, `page`): `Promise`\<[`boolean`, ``null`` \| `T`]\>
+
+------------------ EXTRACT ------------------ *
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | ``ExtractOptions``\<`T`\> |
+| `page` | `any` |
+
+#### Returns
+
+`Promise`\<[`boolean`, ``null`` \| `T`]\>
+
+___
+
+### extractAsync
+
+▸ **extractAsync**\<`T`\>(`options`, `page`): `Promise`\<[`boolean`, ``null`` \| `T`]\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | ``ExtractOptions``\<`T`\> |
+| `page` | `any` |
+
+#### Returns
+
+`Promise`\<[`boolean`, ``null`` \| `T`]\>
+
+___
+
+### observe
+
+▸ **observe**(`options`, `page`): `Promise`\<``boolean`, [`ObserveResult``[]]\>
+
+------------------ OBSERVE ------------------ *
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | ``ObserveOptions`` |
+| `page` | `any` |
+
+#### Returns
+
+`Promise`\<``boolean`, [`ObserveResult``[]]\>
+
+___
+
+### observeAsync
+
+▸ **observeAsync**(`options`, `page`): `Promise`\<``boolean`, [`ObserveResult``[]]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | ``ObserveOptions`` |
+| `page` | `any` |
+
+#### Returns
+
+`Promise`\<``boolean`, [`ObserveResult``[]]\>

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

@@ -31,7 +31,7 @@ screenshot capture, and content extraction. It enables automated testing and web
 ## Properties
 
 ```typescript
-agent: ``BrowserAgent``
+agent: [`BrowserAgent`](browser-agent.md)
 ```
 
 

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

@@ -0,0 +1,154 @@
+# Class: FingerprintFormat
+
+Complete fingerprint format including fingerprint data and headers.
+
+## Table of contents
+
+
+### Properties
+
+
+### Methods
+
+- [create](#create)
+- [fromDict](#fromdict)
+- [fromJson](#fromjson)
+- [load](#load)
+- [toDict](#todict)
+- [toJson](#tojson)
+
+## Properties
+
+```typescript
+fingerprint: ``Fingerprint``
+headers: `Record`<`string`, `string`>
+```
+
+
+## Methods
+
+### create
+
+▸ **create**(`screen`, `navigator`, `videoCard`, `headers`, `videoCodecs?`, `audioCodecs?`, `pluginsData?`, `battery?`, `multimediaDevices?`, `fonts?`, `mockWebRTC?`, `slim?`): [`FingerprintFormat`](fingerprint.md)
+
+Create FingerprintFormat directly using component interfaces.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `screen` | ``ScreenFingerprint`` | `undefined` |
+| `navigator` | ``NavigatorFingerprint`` | `undefined` |
+| `videoCard` | ``VideoCard`` | `undefined` |
+| `headers` | `Record`\<`string`, `string`\> | `undefined` |
+| `videoCodecs?` | `Record`\<`string`, `string`\> | `undefined` |
+| `audioCodecs?` | `Record`\<`string`, `string`\> | `undefined` |
+| `pluginsData?` | `Record`\<`string`, `string`\> | `undefined` |
+| `battery?` | `Record`\<`string`, `string`\> | `undefined` |
+| `multimediaDevices?` | `string`[] | `undefined` |
+| `fonts?` | `string`[] | `undefined` |
+| `mockWebRTC` | `boolean` | `false` |
+| `slim?` | `boolean` | `undefined` |
+
+#### Returns
+
+[`FingerprintFormat`](fingerprint.md)
+
+___
+
+### fromDict
+
+▸ **fromDict**(`data`): [`FingerprintFormat`](fingerprint.md)
+
+Create FingerprintFormat from dictionary data.
+Note: Used internally by SDK modules.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `Record`\<`string`, `any`\> |
+
+#### Returns
+
+[`FingerprintFormat`](fingerprint.md)
+
+___
+
+### fromJson
+
+▸ **fromJson**(`jsonStr`): [`FingerprintFormat`](fingerprint.md)
+
+Create FingerprintFormat from JSON string.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `jsonStr` | `string` |
+
+#### Returns
+
+[`FingerprintFormat`](fingerprint.md)
+
+___
+
+### load
+
+▸ **load**(`data`): [`FingerprintFormat`](fingerprint.md)
+
+Load fingerprint format from dict or JSON string.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `data` | `string` \| `Record`\<`string`, `any`\> | Dictionary or JSON string containing fingerprint data |
+
+#### Returns
+
+[`FingerprintFormat`](fingerprint.md)
+
+FingerprintFormat instance
+
+**`Example`**
+
+```typescript
+// From dict
+const fp = FingerprintFormat.load({fingerprint: {...}, headers: {...}});
+// From JSON file
+const data = fs.readFileSync('fingerprint.json', 'utf8');
+const fp2 = FingerprintFormat.load(data);
+```
+
+___
+
+### toDict
+
+▸ **toDict**(): `Record`\<`string`, `any`\>
+
+Convert to dictionary format.
+Note: Used internally by SDK modules.
+
+#### Returns
+
+`Record`\<`string`, `any`\>
+
+___
+
+### toJson
+
+▸ **toJson**(`indent?`): `string`
+
+Convert to JSON string format.
+Note: Used internally by SDK modules.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `indent` | `number` | `2` |
+
+#### Returns
+
+`string`

package/docs/api/common-features/basics/agentbay.md

@@ -40,7 +40,7 @@ Creates a new AgentBay session with specified configuration.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `params` | ``CreateSessionParams`` | Configuration parameters for the session: - labels: Key-value pairs for session metadata - imageId: Custom image ID for the session environment - contextSync: Array of context synchronization configurations - browserContext: Browser-specific context configuration - isVpc: Whether to create a VPC session - policyId: Security policy ID - enableBrowserReplay: Enable browser session recording - extraConfigs: Additional configuration options - framework: Framework identifier for tracking |
+| `params` | [`CreateSessionParams`](session-params.md) | Configuration parameters for the session: - labels: Key-value pairs for session metadata - imageId: Custom image ID for the session environment - contextSync: Array of context synchronization configurations - browserContext: Browser-specific context configuration - isVpc: Whether to create a VPC session - policyId: Security policy ID - enableBrowserReplay: Enable browser session recording - extraConfigs: Additional configuration options - framework: Framework identifier for tracking |
 
 #### Returns
 

package/docs/api/common-features/basics/session-params.md

@@ -0,0 +1,71 @@
+# Interface: CreateSessionParams
+
+Parameters for creating a session.
+
+## Table of contents
+
+### Properties
+
+- [browserContext](#browsercontext)
+- [contextSync](#contextsync)
+- [enableBrowserReplay](#enablebrowserreplay)
+- [extraConfigs](#extraconfigs)
+- [framework](#framework)
+- [imageId](#imageid)
+- [isVpc](#isvpc)
+- [labels](#labels)
+- [policyId](#policyid)
+
+## Properties
+
+### browserContext
+
+• `Optional` **browserContext**: ``BrowserContext``
+
+___
+
+### contextSync
+
+• `Optional` **contextSync**: [`ContextSync`](context-sync.md)[]
+
+___
+
+### enableBrowserReplay
+
+• `Optional` **enableBrowserReplay**: `boolean`
+
+___
+
+### extraConfigs
+
+• `Optional` **extraConfigs**: ``ExtraConfigs``
+
+___
+
+### framework
+
+• `Optional` **framework**: `string`
+
+___
+
+### imageId
+
+• `Optional` **imageId**: `string`
+
+___
+
+### isVpc
+
+• `Optional` **isVpc**: `boolean`
+
+___
+
+### labels
+
+• `Optional` **labels**: `Record`\<`string`, `string`\>
+
+___
+
+### policyId
+
+• `Optional` **policyId**: `string`

package/docs/api/mobile-use/mobile-simulate.md

@@ -0,0 +1,135 @@
+# Class: MobileSimulateService
+
+Provides methods to manage persistent mobile dev info and sync to the mobile device.
+
+## Table of contents
+
+
+### Methods
+
+- [hasMobileInfo](#hasmobileinfo)
+- [setSimulateContextId](#setsimulatecontextid)
+- [setSimulateEnable](#setsimulateenable)
+- [setSimulateMode](#setsimulatemode)
+- [uploadMobileInfo](#uploadmobileinfo)
+
+## Methods
+
+### hasMobileInfo
+
+▸ **hasMobileInfo**(`contextSync`): `Promise`\<`boolean`\>
+
+Check if the mobile dev info file exists in one context sync. (Only for user provided context sync)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `contextSync` | [`ContextSync`](../common-features/basics/context-sync.md) | The context sync to check. |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the mobile dev info file exists, False otherwise.
+
+**`Throws`**
+
+Error if context_sync is not provided or context_sync.context_id or context_sync.path is not provided.
+
+**`Remarks`**
+
+This method can only be used when mobile simulate context sync is managed by user side. For internal mobile simulate
+context sync, this method will not work.
+
+___
+
+### setSimulateContextId
+
+▸ **setSimulateContextId**(`contextId`): `void`
+
+Set a previously saved simulate context id. Please make sure the context id is provided by MobileSimulateService
+but not user side created context.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `contextId` | `string` | The context ID of the previously saved mobile simulate context. |
+
+#### Returns
+
+`void`
+
+___
+
+### setSimulateEnable
+
+▸ **setSimulateEnable**(`enable`): `void`
+
+Set the simulate enable flag.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `enable` | `boolean` | The simulate feature enable flag. |
+
+#### Returns
+
+`void`
+
+___
+
+### setSimulateMode
+
+▸ **setSimulateMode**(`mode`): `void`
+
+Set the simulate mode.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `mode` | ``MobileSimulateMode`` | The simulate mode. - PropertiesOnly: Simulate only device properties. - SensorsOnly: Simulate only device sensors. - PackagesOnly: Simulate only installed packages. - ServicesOnly: Simulate only system services. - All: Simulate all aspects of the device. |
+
+#### Returns
+
+`void`
+
+___
+
+### uploadMobileInfo
+
+▸ **uploadMobileInfo**(`mobileDevInfoContent`, `contextSync?`): `Promise`\<``MobileSimulateUploadResult``\>
+
+Upload the mobile simulate dev info.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `mobileDevInfoContent` | `string` | The mobile simulate dev info content to upload. |
+| `contextSync?` | [`ContextSync`](../common-features/basics/context-sync.md) | Optional - If not provided, a new context sync will be created for the mobile simulate service and this context id will be returned by the MobileSimulateUploadResult. User can use this context id to do persistent mobile simulate across sessions. - If provided, the mobile simulate dev info will be uploaded to the context sync in a specific path. |
+
+#### Returns
+
+`Promise`\<``MobileSimulateUploadResult``\>
+
+The result of the upload operation.
+
+**`Throws`**
+
+Error if mobile_dev_info_content is not provided or not a valid JSON string.
+
+**`Throws`**
+
+Error if context_sync is provided but context_sync.context_id is not provided.
+
+**`Remarks`**
+
+If context_sync is not provided, a new context sync will be created for the mobile simulate.
+If context_sync is provided, the mobile simulate dev info will be uploaded to the context sync.
+If the mobile simulate dev info already exists in the context sync, the context sync will be updated.
+If the mobile simulate dev info does not exist in the context sync, the context sync will be created.
+If the upload operation fails, the error message will be returned.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-wuying-agentbay-sdk",
-  "version": "0.13.0-beta.20251211155407",
+  "version": "0.13.0-beta.20251211205534",
   "description": "TypeScript SDK for interacting with the Wuying AgentBay cloud runtime environment",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",