test-wuying-agentbay-sdk 0.13.0-beta.20251211201417 → 0.13.0-beta.20251212103901

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/docs/api/README.md +4 -0
  2. package/docs/api/browser-use/browser-agent.md +133 -0
  3. package/docs/api/browser-use/browser.md +1 -1
  4. package/docs/api/browser-use/fingerprint.md +154 -0
  5. package/docs/api/common-features/basics/agentbay.md +1 -1
  6. package/docs/api/common-features/basics/session-params.md +71 -0
  7. package/docs/api/mobile-use/mobile-simulate.md +135 -0
  8. package/package.json +1 -1
package/docs/api/README.md CHANGED
@@ -4,8 +4,10 @@ These documents are generated automatically using TypeDoc. Run `npm run docs:gen
4
4
 
5
5
  ## Structure
6
6
  - `browser-use`
7
+ - browser-agent.md
7
8
  - browser.md
8
9
  - extension.md
10
+ - fingerprint.md
9
11
  - `codespace`
10
12
  - code.md
11
13
  - `common-features/advanced`
@@ -21,8 +23,10 @@ These documents are generated automatically using TypeDoc. Run `npm run docs:gen
21
23
  - context.md
22
24
  - filesystem.md
23
25
  - logging.md
26
+ - session-params.md
24
27
  - session.md
25
28
  - `computer-use`
26
29
  - computer.md
27
30
  - `mobile-use`
31
+ - mobile-simulate.md
28
32
  - mobile.md
package/docs/api/browser-use/browser-agent.md ADDED
@@ -0,0 +1,133 @@
1
+ # Class: BrowserAgent
2
+
3
+ ## Table of contents
4
+
5
+
6
+ ### Methods
7
+
8
+ - [act](#act)
9
+ - [actAsync](#actasync)
10
+ - [extract](#extract)
11
+ - [extractAsync](#extractasync)
12
+ - [observe](#observe)
13
+ - [observeAsync](#observeasync)
14
+
15
+ ## Methods
16
+
17
+ ### act
18
+
19
+ ▸ **act**(`options`, `page`): `Promise`\<``ActResult``\>
20
+
21
+ ------------------ ACT ------------------ *
22
+
23
+ #### Parameters
24
+
25
+ | Name | Type |
26
+ | :------ | :------ |
27
+ | `options` | ``ActOptions`` |
28
+ | `page` | `any` |
29
+
30
+ #### Returns
31
+
32
+ `Promise`\<``ActResult``\>
33
+
34
+ ___
35
+
36
+ ### actAsync
37
+
38
+ ▸ **actAsync**(`options`, `page`): `Promise`\<``ActResult``\>
39
+
40
+ #### Parameters
41
+
42
+ | Name | Type |
43
+ | :------ | :------ |
44
+ | `options` | ``ActOptions`` |
45
+ | `page` | `any` |
46
+
47
+ #### Returns
48
+
49
+ `Promise`\<``ActResult``\>
50
+
51
+ ___
52
+
53
+ ### extract
54
+
55
+ ▸ **extract**\<`T`\>(`options`, `page`): `Promise`\<[`boolean`, ``null`` \| `T`]\>
56
+
57
+ ------------------ EXTRACT ------------------ *
58
+
59
+ #### Type parameters
60
+
61
+ | Name |
62
+ | :------ |
63
+ | `T` |
64
+
65
+ #### Parameters
66
+
67
+ | Name | Type |
68
+ | :------ | :------ |
69
+ | `options` | ``ExtractOptions``\<`T`\> |
70
+ | `page` | `any` |
71
+
72
+ #### Returns
73
+
74
+ `Promise`\<[`boolean`, ``null`` \| `T`]\>
75
+
76
+ ___
77
+
78
+ ### extractAsync
79
+
80
+ ▸ **extractAsync**\<`T`\>(`options`, `page`): `Promise`\<[`boolean`, ``null`` \| `T`]\>
81
+
82
+ #### Type parameters
83
+
84
+ | Name |
85
+ | :------ |
86
+ | `T` |
87
+
88
+ #### Parameters
89
+
90
+ | Name | Type |
91
+ | :------ | :------ |
92
+ | `options` | ``ExtractOptions``\<`T`\> |
93
+ | `page` | `any` |
94
+
95
+ #### Returns
96
+
97
+ `Promise`\<[`boolean`, ``null`` \| `T`]\>
98
+
99
+ ___
100
+
101
+ ### observe
102
+
103
+ ▸ **observe**(`options`, `page`): `Promise`\<``boolean`, [`ObserveResult``[]]\>
104
+
105
+ ------------------ OBSERVE ------------------ *
106
+
107
+ #### Parameters
108
+
109
+ | Name | Type |
110
+ | :------ | :------ |
111
+ | `options` | ``ObserveOptions`` |
112
+ | `page` | `any` |
113
+
114
+ #### Returns
115
+
116
+ `Promise`\<``boolean`, [`ObserveResult``[]]\>
117
+
118
+ ___
119
+
120
+ ### observeAsync
121
+
122
+ ▸ **observeAsync**(`options`, `page`): `Promise`\<``boolean`, [`ObserveResult``[]]\>
123
+
124
+ #### Parameters
125
+
126
+ | Name | Type |
127
+ | :------ | :------ |
128
+ | `options` | ``ObserveOptions`` |
129
+ | `page` | `any` |
130
+
131
+ #### Returns
132
+
133
+ `Promise`\<``boolean`, [`ObserveResult``[]]\>
package/docs/api/browser-use/browser.md CHANGED
@@ -31,7 +31,7 @@ screenshot capture, and content extraction. It enables automated testing and web
31
31
  ## Properties
32
32
 
33
33
  ```typescript
34
- agent: ``BrowserAgent``
34
+ agent: [`BrowserAgent`](browser-agent.md)
35
35
  ```
36
36
 
37
37
 
package/docs/api/browser-use/fingerprint.md ADDED
@@ -0,0 +1,154 @@
1
+ # Class: FingerprintFormat
2
+
3
+ Complete fingerprint format including fingerprint data and headers.
4
+
5
+ ## Table of contents
6
+
7
+
8
+ ### Properties
9
+
10
+
11
+ ### Methods
12
+
13
+ - [create](#create)
14
+ - [fromDict](#fromdict)
15
+ - [fromJson](#fromjson)
16
+ - [load](#load)
17
+ - [toDict](#todict)
18
+ - [toJson](#tojson)
19
+
20
+ ## Properties
21
+
22
+ ```typescript
23
+ fingerprint: ``Fingerprint``
24
+ headers: `Record`<`string`, `string`>
25
+ ```
26
+
27
+
28
+ ## Methods
29
+
30
+ ### create
31
+
32
+ ▸ **create**(`screen`, `navigator`, `videoCard`, `headers`, `videoCodecs?`, `audioCodecs?`, `pluginsData?`, `battery?`, `multimediaDevices?`, `fonts?`, `mockWebRTC?`, `slim?`): [`FingerprintFormat`](fingerprint.md)
33
+
34
+ Create FingerprintFormat directly using component interfaces.
35
+
36
+ #### Parameters
37
+
38
+ | Name | Type | Default value |
39
+ | :------ | :------ | :------ |
40
+ | `screen` | ``ScreenFingerprint`` | `undefined` |
41
+ | `navigator` | ``NavigatorFingerprint`` | `undefined` |
42
+ | `videoCard` | ``VideoCard`` | `undefined` |
43
+ | `headers` | `Record`\<`string`, `string`\> | `undefined` |
44
+ | `videoCodecs?` | `Record`\<`string`, `string`\> | `undefined` |
45
+ | `audioCodecs?` | `Record`\<`string`, `string`\> | `undefined` |
46
+ | `pluginsData?` | `Record`\<`string`, `string`\> | `undefined` |
47
+ | `battery?` | `Record`\<`string`, `string`\> | `undefined` |
48
+ | `multimediaDevices?` | `string`[] | `undefined` |
49
+ | `fonts?` | `string`[] | `undefined` |
50
+ | `mockWebRTC` | `boolean` | `false` |
51
+ | `slim?` | `boolean` | `undefined` |
52
+
53
+ #### Returns
54
+
55
+ [`FingerprintFormat`](fingerprint.md)
56
+
57
+ ___
58
+
59
+ ### fromDict
60
+
61
+ ▸ **fromDict**(`data`): [`FingerprintFormat`](fingerprint.md)
62
+
63
+ Create FingerprintFormat from dictionary data.
64
+ Note: Used internally by SDK modules.
65
+
66
+ #### Parameters
67
+
68
+ | Name | Type |
69
+ | :------ | :------ |
70
+ | `data` | `Record`\<`string`, `any`\> |
71
+
72
+ #### Returns
73
+
74
+ [`FingerprintFormat`](fingerprint.md)
75
+
76
+ ___
77
+
78
+ ### fromJson
79
+
80
+ ▸ **fromJson**(`jsonStr`): [`FingerprintFormat`](fingerprint.md)
81
+
82
+ Create FingerprintFormat from JSON string.
83
+
84
+ #### Parameters
85
+
86
+ | Name | Type |
87
+ | :------ | :------ |
88
+ | `jsonStr` | `string` |
89
+
90
+ #### Returns
91
+
92
+ [`FingerprintFormat`](fingerprint.md)
93
+
94
+ ___
95
+
96
+ ### load
97
+
98
+ ▸ **load**(`data`): [`FingerprintFormat`](fingerprint.md)
99
+
100
+ Load fingerprint format from dict or JSON string.
101
+
102
+ #### Parameters
103
+
104
+ | Name | Type | Description |
105
+ | :------ | :------ | :------ |
106
+ | `data` | `string` \| `Record`\<`string`, `any`\> | Dictionary or JSON string containing fingerprint data |
107
+
108
+ #### Returns
109
+
110
+ [`FingerprintFormat`](fingerprint.md)
111
+
112
+ FingerprintFormat instance
113
+
114
+ **`Example`**
115
+
116
+ ```typescript
117
+ // From dict
118
+ const fp = FingerprintFormat.load({fingerprint: {...}, headers: {...}});
119
+ // From JSON file
120
+ const data = fs.readFileSync('fingerprint.json', 'utf8');
121
+ const fp2 = FingerprintFormat.load(data);
122
+ ```
123
+
124
+ ___
125
+
126
+ ### toDict
127
+
128
+ ▸ **toDict**(): `Record`\<`string`, `any`\>
129
+
130
+ Convert to dictionary format.
131
+ Note: Used internally by SDK modules.
132
+
133
+ #### Returns
134
+
135
+ `Record`\<`string`, `any`\>
136
+
137
+ ___
138
+
139
+ ### toJson
140
+
141
+ ▸ **toJson**(`indent?`): `string`
142
+
143
+ Convert to JSON string format.
144
+ Note: Used internally by SDK modules.
145
+
146
+ #### Parameters
147
+
148
+ | Name | Type | Default value |
149
+ | :------ | :------ | :------ |
150
+ | `indent` | `number` | `2` |
151
+
152
+ #### Returns
153
+
154
+ `string`
package/docs/api/common-features/basics/agentbay.md CHANGED
@@ -40,7 +40,7 @@ Creates a new AgentBay session with specified configuration.
40
40
 
41
41
  | Name | Type | Description |
42
42
  | :------ | :------ | :------ |
43
- | `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 |
43
+ | `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 |
44
44
 
45
45
  #### Returns
46
46
 
package/docs/api/common-features/basics/session-params.md ADDED
@@ -0,0 +1,71 @@
1
+ # Interface: CreateSessionParams
2
+
3
+ Parameters for creating a session.
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [browserContext](#browsercontext)
10
+ - [contextSync](#contextsync)
11
+ - [enableBrowserReplay](#enablebrowserreplay)
12
+ - [extraConfigs](#extraconfigs)
13
+ - [framework](#framework)
14
+ - [imageId](#imageid)
15
+ - [isVpc](#isvpc)
16
+ - [labels](#labels)
17
+ - [policyId](#policyid)
18
+
19
+ ## Properties
20
+
21
+ ### browserContext
22
+
23
+ • `Optional` **browserContext**: ``BrowserContext``
24
+
25
+ ___
26
+
27
+ ### contextSync
28
+
29
+ • `Optional` **contextSync**: [`ContextSync`](context-sync.md)[]
30
+
31
+ ___
32
+
33
+ ### enableBrowserReplay
34
+
35
+ • `Optional` **enableBrowserReplay**: `boolean`
36
+
37
+ ___
38
+
39
+ ### extraConfigs
40
+
41
+ • `Optional` **extraConfigs**: ``ExtraConfigs``
42
+
43
+ ___
44
+
45
+ ### framework
46
+
47
+ • `Optional` **framework**: `string`
48
+
49
+ ___
50
+
51
+ ### imageId
52
+
53
+ • `Optional` **imageId**: `string`
54
+
55
+ ___
56
+
57
+ ### isVpc
58
+
59
+ • `Optional` **isVpc**: `boolean`
60
+
61
+ ___
62
+
63
+ ### labels
64
+
65
+ • `Optional` **labels**: `Record`\<`string`, `string`\>
66
+
67
+ ___
68
+
69
+ ### policyId
70
+
71
+ • `Optional` **policyId**: `string`
package/docs/api/mobile-use/mobile-simulate.md ADDED
@@ -0,0 +1,135 @@
1
+ # Class: MobileSimulateService
2
+
3
+ Provides methods to manage persistent mobile dev info and sync to the mobile device.
4
+
5
+ ## Table of contents
6
+
7
+
8
+ ### Methods
9
+
10
+ - [hasMobileInfo](#hasmobileinfo)
11
+ - [setSimulateContextId](#setsimulatecontextid)
12
+ - [setSimulateEnable](#setsimulateenable)
13
+ - [setSimulateMode](#setsimulatemode)
14
+ - [uploadMobileInfo](#uploadmobileinfo)
15
+
16
+ ## Methods
17
+
18
+ ### hasMobileInfo
19
+
20
+ ▸ **hasMobileInfo**(`contextSync`): `Promise`\<`boolean`\>
21
+
22
+ Check if the mobile dev info file exists in one context sync. (Only for user provided context sync)
23
+
24
+ #### Parameters
25
+
26
+ | Name | Type | Description |
27
+ | :------ | :------ | :------ |
28
+ | `contextSync` | [`ContextSync`](../common-features/basics/context-sync.md) | The context sync to check. |
29
+
30
+ #### Returns
31
+
32
+ `Promise`\<`boolean`\>
33
+
34
+ True if the mobile dev info file exists, False otherwise.
35
+
36
+ **`Throws`**
37
+
38
+ Error if context_sync is not provided or context_sync.context_id or context_sync.path is not provided.
39
+
40
+ **`Remarks`**
41
+
42
+ This method can only be used when mobile simulate context sync is managed by user side. For internal mobile simulate
43
+ context sync, this method will not work.
44
+
45
+ ___
46
+
47
+ ### setSimulateContextId
48
+
49
+ ▸ **setSimulateContextId**(`contextId`): `void`
50
+
51
+ Set a previously saved simulate context id. Please make sure the context id is provided by MobileSimulateService
52
+ but not user side created context.
53
+
54
+ #### Parameters
55
+
56
+ | Name | Type | Description |
57
+ | :------ | :------ | :------ |
58
+ | `contextId` | `string` | The context ID of the previously saved mobile simulate context. |
59
+
60
+ #### Returns
61
+
62
+ `void`
63
+
64
+ ___
65
+
66
+ ### setSimulateEnable
67
+
68
+ ▸ **setSimulateEnable**(`enable`): `void`
69
+
70
+ Set the simulate enable flag.
71
+
72
+ #### Parameters
73
+
74
+ | Name | Type | Description |
75
+ | :------ | :------ | :------ |
76
+ | `enable` | `boolean` | The simulate feature enable flag. |
77
+
78
+ #### Returns
79
+
80
+ `void`
81
+
82
+ ___
83
+
84
+ ### setSimulateMode
85
+
86
+ ▸ **setSimulateMode**(`mode`): `void`
87
+
88
+ Set the simulate mode.
89
+
90
+ #### Parameters
91
+
92
+ | Name | Type | Description |
93
+ | :------ | :------ | :------ |
94
+ | `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. |
95
+
96
+ #### Returns
97
+
98
+ `void`
99
+
100
+ ___
101
+
102
+ ### uploadMobileInfo
103
+
104
+ ▸ **uploadMobileInfo**(`mobileDevInfoContent`, `contextSync?`): `Promise`\<``MobileSimulateUploadResult``\>
105
+
106
+ Upload the mobile simulate dev info.
107
+
108
+ #### Parameters
109
+
110
+ | Name | Type | Description |
111
+ | :------ | :------ | :------ |
112
+ | `mobileDevInfoContent` | `string` | The mobile simulate dev info content to upload. |
113
+ | `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. |
114
+
115
+ #### Returns
116
+
117
+ `Promise`\<``MobileSimulateUploadResult``\>
118
+
119
+ The result of the upload operation.
120
+
121
+ **`Throws`**
122
+
123
+ Error if mobile_dev_info_content is not provided or not a valid JSON string.
124
+
125
+ **`Throws`**
126
+
127
+ Error if context_sync is provided but context_sync.context_id is not provided.
128
+
129
+ **`Remarks`**
130
+
131
+ If context_sync is not provided, a new context sync will be created for the mobile simulate.
132
+ If context_sync is provided, the mobile simulate dev info will be uploaded to the context sync.
133
+ If the mobile simulate dev info already exists in the context sync, the context sync will be updated.
134
+ If the mobile simulate dev info does not exist in the context sync, the context sync will be created.
135
+ If the upload operation fails, the error message will be returned.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "test-wuying-agentbay-sdk",
3
- "version": "0.13.0-beta.20251211201417",
3
+ "version": "0.13.0-beta.20251212103901",
4
4
  "description": "TypeScript SDK for interacting with the Wuying AgentBay cloud runtime environment",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",