test-wuying-agentbay-sdk 0.13.0-beta.20251217175633 → 0.13.0-beta.20251218114222
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.
- package/dist/{chunk-VEHDE3LU.mjs → chunk-P2CXYF4T.mjs} +99 -2
- package/dist/chunk-P2CXYF4T.mjs.map +1 -0
- package/dist/{chunk-QYUGADDC.cjs → chunk-WVWGLZDT.cjs} +100 -3
- package/dist/chunk-WVWGLZDT.cjs.map +1 -0
- package/dist/index.cjs +173 -69
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +70 -3
- package/dist/index.d.ts +70 -3
- package/dist/index.mjs +114 -10
- package/dist/index.mjs.map +1 -1
- package/dist/{model-NXNY7XBJ.mjs → model-BRLR6F3P.mjs} +8 -2
- package/dist/model-KJHN3WYY.cjs +214 -0
- package/dist/{model-TL7UT6WY.cjs.map → model-KJHN3WYY.cjs.map} +1 -1
- package/docs/api/common-features/basics/agentbay.md +3 -2
- package/docs/api/common-features/basics/session-params.md +322 -11
- package/package.json +1 -1
- package/dist/chunk-QYUGADDC.cjs.map +0 -1
- package/dist/chunk-VEHDE3LU.mjs.map +0 -1
- package/dist/model-TL7UT6WY.cjs +0 -208
- /package/dist/{model-NXNY7XBJ.mjs.map → model-BRLR6F3P.mjs.map} +0 -0
|
@@ -30,6 +30,9 @@ import {
|
|
|
30
30
|
DeleteContextRequest,
|
|
31
31
|
DeleteContextResponse,
|
|
32
32
|
DeleteContextResponseBody,
|
|
33
|
+
DeleteSessionAsyncRequest,
|
|
34
|
+
DeleteSessionAsyncResponse,
|
|
35
|
+
DeleteSessionAsyncResponseBody,
|
|
33
36
|
DescribeContextFilesRequest,
|
|
34
37
|
DescribeContextFilesResponse,
|
|
35
38
|
DescribeContextFilesResponseBody,
|
|
@@ -109,7 +112,7 @@ import {
|
|
|
109
112
|
SyncContextRequest,
|
|
110
113
|
SyncContextResponse,
|
|
111
114
|
SyncContextResponseBody
|
|
112
|
-
} from "./chunk-
|
|
115
|
+
} from "./chunk-P2CXYF4T.mjs";
|
|
113
116
|
import "./chunk-KNEDRAP6.mjs";
|
|
114
117
|
export {
|
|
115
118
|
ApplyMqttTokenRequest,
|
|
@@ -134,6 +137,9 @@ export {
|
|
|
134
137
|
DeleteContextRequest,
|
|
135
138
|
DeleteContextResponse,
|
|
136
139
|
DeleteContextResponseBody,
|
|
140
|
+
DeleteSessionAsyncRequest,
|
|
141
|
+
DeleteSessionAsyncResponse,
|
|
142
|
+
DeleteSessionAsyncResponseBody,
|
|
137
143
|
DescribeContextFilesRequest,
|
|
138
144
|
DescribeContextFilesResponse,
|
|
139
145
|
DescribeContextFilesResponseBody,
|
|
@@ -214,4 +220,4 @@ export {
|
|
|
214
220
|
SyncContextResponse,
|
|
215
221
|
SyncContextResponseBody
|
|
216
222
|
};
|
|
217
|
-
//# sourceMappingURL=model-
|
|
223
|
+
//# sourceMappingURL=model-BRLR6F3P.mjs.map
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
var _chunkWVWGLZDTcjs = require('./chunk-WVWGLZDT.cjs');
|
|
107
|
+
require('./chunk-4IPTHWLM.cjs');
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
exports.ApplyMqttTokenRequest = _chunkWVWGLZDTcjs.ApplyMqttTokenRequest; exports.ApplyMqttTokenResponse = _chunkWVWGLZDTcjs.ApplyMqttTokenResponse; exports.ApplyMqttTokenResponseBody = _chunkWVWGLZDTcjs.ApplyMqttTokenResponseBody; exports.ApplyMqttTokenResponseBodyData = _chunkWVWGLZDTcjs.ApplyMqttTokenResponseBodyData; exports.CallMcpToolRequest = _chunkWVWGLZDTcjs.CallMcpToolRequest; exports.CallMcpToolResponse = _chunkWVWGLZDTcjs.CallMcpToolResponse; exports.CallMcpToolResponseBody = _chunkWVWGLZDTcjs.CallMcpToolResponseBody; exports.ClearContextRequest = _chunkWVWGLZDTcjs.ClearContextRequest; exports.ClearContextResponse = _chunkWVWGLZDTcjs.ClearContextResponse; exports.ClearContextResponseBody = _chunkWVWGLZDTcjs.ClearContextResponseBody; exports.CreateMcpSessionRequest = _chunkWVWGLZDTcjs.CreateMcpSessionRequest; exports.CreateMcpSessionRequestPersistenceDataList = _chunkWVWGLZDTcjs.CreateMcpSessionRequestPersistenceDataList; exports.CreateMcpSessionResponse = _chunkWVWGLZDTcjs.CreateMcpSessionResponse; exports.CreateMcpSessionResponseBody = _chunkWVWGLZDTcjs.CreateMcpSessionResponseBody; exports.CreateMcpSessionResponseBodyData = _chunkWVWGLZDTcjs.CreateMcpSessionResponseBodyData; exports.CreateMcpSessionShrinkRequest = _chunkWVWGLZDTcjs.CreateMcpSessionShrinkRequest; exports.DeleteContextFileRequest = _chunkWVWGLZDTcjs.DeleteContextFileRequest; exports.DeleteContextFileResponse = _chunkWVWGLZDTcjs.DeleteContextFileResponse; exports.DeleteContextFileResponseBody = _chunkWVWGLZDTcjs.DeleteContextFileResponseBody; exports.DeleteContextRequest = _chunkWVWGLZDTcjs.DeleteContextRequest; exports.DeleteContextResponse = _chunkWVWGLZDTcjs.DeleteContextResponse; exports.DeleteContextResponseBody = _chunkWVWGLZDTcjs.DeleteContextResponseBody; exports.DeleteSessionAsyncRequest = _chunkWVWGLZDTcjs.DeleteSessionAsyncRequest; exports.DeleteSessionAsyncResponse = _chunkWVWGLZDTcjs.DeleteSessionAsyncResponse; exports.DeleteSessionAsyncResponseBody = _chunkWVWGLZDTcjs.DeleteSessionAsyncResponseBody; exports.DescribeContextFilesRequest = _chunkWVWGLZDTcjs.DescribeContextFilesRequest; exports.DescribeContextFilesResponse = _chunkWVWGLZDTcjs.DescribeContextFilesResponse; exports.DescribeContextFilesResponseBody = _chunkWVWGLZDTcjs.DescribeContextFilesResponseBody; exports.GetAdbLinkRequest = _chunkWVWGLZDTcjs.GetAdbLinkRequest; exports.GetAdbLinkResponse = _chunkWVWGLZDTcjs.GetAdbLinkResponse; exports.GetAdbLinkResponseBody = _chunkWVWGLZDTcjs.GetAdbLinkResponseBody; exports.GetAdbLinkResponseBodyData = _chunkWVWGLZDTcjs.GetAdbLinkResponseBodyData; exports.GetAndLoadInternalContextRequest = _chunkWVWGLZDTcjs.GetAndLoadInternalContextRequest; exports.GetAndLoadInternalContextResponse = _chunkWVWGLZDTcjs.GetAndLoadInternalContextResponse; exports.GetAndLoadInternalContextResponseBody = _chunkWVWGLZDTcjs.GetAndLoadInternalContextResponseBody; exports.GetAndLoadInternalContextResponseBodyData = _chunkWVWGLZDTcjs.GetAndLoadInternalContextResponseBodyData; exports.GetCdpLinkRequest = _chunkWVWGLZDTcjs.GetCdpLinkRequest; exports.GetCdpLinkResponse = _chunkWVWGLZDTcjs.GetCdpLinkResponse; exports.GetCdpLinkResponseBody = _chunkWVWGLZDTcjs.GetCdpLinkResponseBody; exports.GetCdpLinkResponseBodyData = _chunkWVWGLZDTcjs.GetCdpLinkResponseBodyData; exports.GetContextFileDownloadUrlRequest = _chunkWVWGLZDTcjs.GetContextFileDownloadUrlRequest; exports.GetContextFileDownloadUrlResponse = _chunkWVWGLZDTcjs.GetContextFileDownloadUrlResponse; exports.GetContextFileDownloadUrlResponseBody = _chunkWVWGLZDTcjs.GetContextFileDownloadUrlResponseBody; exports.GetContextFileUploadUrlRequest = _chunkWVWGLZDTcjs.GetContextFileUploadUrlRequest; exports.GetContextFileUploadUrlResponse = _chunkWVWGLZDTcjs.GetContextFileUploadUrlResponse; exports.GetContextFileUploadUrlResponseBody = _chunkWVWGLZDTcjs.GetContextFileUploadUrlResponseBody; exports.GetContextInfoRequest = _chunkWVWGLZDTcjs.GetContextInfoRequest; exports.GetContextInfoResponse = _chunkWVWGLZDTcjs.GetContextInfoResponse; exports.GetContextInfoResponseBody = _chunkWVWGLZDTcjs.GetContextInfoResponseBody; exports.GetContextInfoResponseBodyData = _chunkWVWGLZDTcjs.GetContextInfoResponseBodyData; exports.GetContextRequest = _chunkWVWGLZDTcjs.GetContextRequest; exports.GetContextResponse = _chunkWVWGLZDTcjs.GetContextResponse; exports.GetContextResponseBody = _chunkWVWGLZDTcjs.GetContextResponseBody; exports.GetContextResponseBodyData = _chunkWVWGLZDTcjs.GetContextResponseBodyData; exports.GetLabelRequest = _chunkWVWGLZDTcjs.GetLabelRequest; exports.GetLabelResponse = _chunkWVWGLZDTcjs.GetLabelResponse; exports.GetLabelResponseBody = _chunkWVWGLZDTcjs.GetLabelResponseBody; exports.GetLabelResponseBodyData = _chunkWVWGLZDTcjs.GetLabelResponseBodyData; exports.GetLinkRequest = _chunkWVWGLZDTcjs.GetLinkRequest; exports.GetLinkResponse = _chunkWVWGLZDTcjs.GetLinkResponse; exports.GetLinkResponseBody = _chunkWVWGLZDTcjs.GetLinkResponseBody; exports.GetLinkResponseBodyData = _chunkWVWGLZDTcjs.GetLinkResponseBodyData; exports.GetMcpResourceRequest = _chunkWVWGLZDTcjs.GetMcpResourceRequest; exports.GetMcpResourceResponse = _chunkWVWGLZDTcjs.GetMcpResourceResponse; exports.GetMcpResourceResponseBody = _chunkWVWGLZDTcjs.GetMcpResourceResponseBody; exports.GetMcpResourceResponseBodyData = _chunkWVWGLZDTcjs.GetMcpResourceResponseBodyData; exports.GetMcpResourceResponseBodyDataDesktopInfo = _chunkWVWGLZDTcjs.GetMcpResourceResponseBodyDataDesktopInfo; exports.GetSessionRequest = _chunkWVWGLZDTcjs.GetSessionRequest; exports.GetSessionResponse = _chunkWVWGLZDTcjs.GetSessionResponse; exports.GetSessionResponseBody = _chunkWVWGLZDTcjs.GetSessionResponseBody; exports.GetSessionResponseBodyData = _chunkWVWGLZDTcjs.GetSessionResponseBodyData; exports.InitBrowserRequest = _chunkWVWGLZDTcjs.InitBrowserRequest; exports.InitBrowserResponse = _chunkWVWGLZDTcjs.InitBrowserResponse; exports.InitBrowserResponseBody = _chunkWVWGLZDTcjs.InitBrowserResponseBody; exports.InitBrowserResponseBodyData = _chunkWVWGLZDTcjs.InitBrowserResponseBodyData; exports.ListContextsRequest = _chunkWVWGLZDTcjs.ListContextsRequest; exports.ListContextsResponse = _chunkWVWGLZDTcjs.ListContextsResponse; exports.ListContextsResponseBody = _chunkWVWGLZDTcjs.ListContextsResponseBody; exports.ListContextsResponseBodyData = _chunkWVWGLZDTcjs.ListContextsResponseBodyData; exports.ListMcpToolsRequest = _chunkWVWGLZDTcjs.ListMcpToolsRequest; exports.ListMcpToolsResponse = _chunkWVWGLZDTcjs.ListMcpToolsResponse; exports.ListMcpToolsResponseBody = _chunkWVWGLZDTcjs.ListMcpToolsResponseBody; exports.ListSessionRequest = _chunkWVWGLZDTcjs.ListSessionRequest; exports.ListSessionResponse = _chunkWVWGLZDTcjs.ListSessionResponse; exports.ListSessionResponseBody = _chunkWVWGLZDTcjs.ListSessionResponseBody; exports.ListSessionResponseBodyData = _chunkWVWGLZDTcjs.ListSessionResponseBodyData; exports.ModifyContextRequest = _chunkWVWGLZDTcjs.ModifyContextRequest; exports.ModifyContextResponse = _chunkWVWGLZDTcjs.ModifyContextResponse; exports.ModifyContextResponseBody = _chunkWVWGLZDTcjs.ModifyContextResponseBody; exports.PauseSessionAsyncRequest = _chunkWVWGLZDTcjs.PauseSessionAsyncRequest; exports.PauseSessionAsyncResponse = _chunkWVWGLZDTcjs.PauseSessionAsyncResponse; exports.PauseSessionAsyncResponseBody = _chunkWVWGLZDTcjs.PauseSessionAsyncResponseBody; exports.ReleaseMcpSessionRequest = _chunkWVWGLZDTcjs.ReleaseMcpSessionRequest; exports.ReleaseMcpSessionResponse = _chunkWVWGLZDTcjs.ReleaseMcpSessionResponse; exports.ReleaseMcpSessionResponseBody = _chunkWVWGLZDTcjs.ReleaseMcpSessionResponseBody; exports.ResumeSessionAsyncRequest = _chunkWVWGLZDTcjs.ResumeSessionAsyncRequest; exports.ResumeSessionAsyncResponse = _chunkWVWGLZDTcjs.ResumeSessionAsyncResponse; exports.ResumeSessionAsyncResponseBody = _chunkWVWGLZDTcjs.ResumeSessionAsyncResponseBody; exports.SetLabelRequest = _chunkWVWGLZDTcjs.SetLabelRequest; exports.SetLabelResponse = _chunkWVWGLZDTcjs.SetLabelResponse; exports.SetLabelResponseBody = _chunkWVWGLZDTcjs.SetLabelResponseBody; exports.SyncContextRequest = _chunkWVWGLZDTcjs.SyncContextRequest; exports.SyncContextResponse = _chunkWVWGLZDTcjs.SyncContextResponse; exports.SyncContextResponseBody = _chunkWVWGLZDTcjs.SyncContextResponseBody;
|
|
214
|
+
//# sourceMappingURL=model-KJHN3WYY.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["/aoneci/runner/work/source/typescript/dist/model-
|
|
1
|
+
{"version":3,"sources":["/aoneci/runner/work/source/typescript/dist/model-KJHN3WYY.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,ujQAAC","file":"/aoneci/runner/work/source/typescript/dist/model-KJHN3WYY.cjs"}
|
|
@@ -24,6 +24,7 @@ Main class for interacting with the AgentBay cloud runtime environment.
|
|
|
24
24
|
## Properties
|
|
25
25
|
|
|
26
26
|
```typescript
|
|
27
|
+
client: ``Client``
|
|
27
28
|
context: [`ContextService`](context.md)
|
|
28
29
|
```
|
|
29
30
|
|
|
@@ -32,7 +33,7 @@ context: [`ContextService`](context.md)
|
|
|
32
33
|
|
|
33
34
|
### create
|
|
34
35
|
|
|
35
|
-
▸ **create**(`params
|
|
36
|
+
▸ **create**(`params`): `Promise`\<`SessionResult`\>
|
|
36
37
|
|
|
37
38
|
Creates a new AgentBay session with specified configuration.
|
|
38
39
|
|
|
@@ -40,7 +41,7 @@ Creates a new AgentBay session with specified configuration.
|
|
|
40
41
|
|
|
41
42
|
| Name | Type | Description |
|
|
42
43
|
| :------ | :------ | :------ |
|
|
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
|
+
| `params` | [`CreateSessionParams`](session-params.md) \| `CreateSeesionWithParams` | 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
45
|
|
|
45
46
|
#### Returns
|
|
46
47
|
|
|
@@ -1,32 +1,65 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Class: CreateSessionParams
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
CreateSessionParams provides a way to configure the parameters for creating a new session
|
|
4
|
+
in the AgentBay cloud environment.
|
|
5
|
+
|
|
6
|
+
## Implements
|
|
7
|
+
|
|
8
|
+
- ``CreateSessionParamsConfig``
|
|
4
9
|
|
|
5
10
|
## Table of contents
|
|
6
11
|
|
|
12
|
+
|
|
7
13
|
### Properties
|
|
8
14
|
|
|
9
15
|
- [browserContext](#browsercontext)
|
|
10
|
-
- [contextSync](#contextsync)
|
|
11
16
|
- [enableBrowserReplay](#enablebrowserreplay)
|
|
12
17
|
- [extraConfigs](#extraconfigs)
|
|
13
18
|
- [framework](#framework)
|
|
14
19
|
- [imageId](#imageid)
|
|
15
|
-
- [isVpc](#isvpc)
|
|
16
|
-
- [labels](#labels)
|
|
17
20
|
- [policyId](#policyid)
|
|
18
21
|
|
|
22
|
+
### Methods
|
|
23
|
+
|
|
24
|
+
- [addContextSync](#addcontextsync)
|
|
25
|
+
- [addContextSyncConfig](#addcontextsyncconfig)
|
|
26
|
+
- [fromJSON](#fromjson)
|
|
27
|
+
- [toJSON](#tojson)
|
|
28
|
+
- [withBrowserContext](#withbrowsercontext)
|
|
29
|
+
- [withContextSync](#withcontextsync)
|
|
30
|
+
- [withEnableBrowserReplay](#withenablebrowserreplay)
|
|
31
|
+
- [withEnableRecord](#withenablerecord)
|
|
32
|
+
- [withExtraConfigs](#withextraconfigs)
|
|
33
|
+
- [withFramework](#withframework)
|
|
34
|
+
- [withImageId](#withimageid)
|
|
35
|
+
- [withIsVpc](#withisvpc)
|
|
36
|
+
- [withLabels](#withlabels)
|
|
37
|
+
- [withPolicyId](#withpolicyid)
|
|
38
|
+
|
|
19
39
|
## Properties
|
|
20
40
|
|
|
41
|
+
```typescript
|
|
42
|
+
contextSync: [`ContextSync`](context-sync.md)[]
|
|
43
|
+
isVpc: `boolean`
|
|
44
|
+
labels: `Record`<`string`, `string`>
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
|
|
21
48
|
### browserContext
|
|
22
49
|
|
|
23
50
|
• `Optional` **browserContext**: ``BrowserContext``
|
|
24
51
|
|
|
52
|
+
Optional configuration for browser data synchronization.
|
|
53
|
+
|
|
54
|
+
#### Implementation of
|
|
55
|
+
|
|
56
|
+
`CreateSessionParamsConfig`.`browserContext`
|
|
57
|
+
|
|
25
58
|
___
|
|
26
59
|
|
|
27
|
-
|
|
60
|
+
#### Implementation of
|
|
28
61
|
|
|
29
|
-
|
|
62
|
+
`CreateSessionParamsConfig`.`contextSync`
|
|
30
63
|
|
|
31
64
|
___
|
|
32
65
|
|
|
@@ -34,38 +67,316 @@ ___
|
|
|
34
67
|
|
|
35
68
|
• `Optional` **enableBrowserReplay**: `boolean`
|
|
36
69
|
|
|
70
|
+
Whether to enable browser recording for the session. Defaults to undefined (use default behavior, enabled by default).
|
|
71
|
+
|
|
72
|
+
#### Implementation of
|
|
73
|
+
|
|
74
|
+
`CreateSessionParamsConfig`.`enableBrowserReplay`
|
|
75
|
+
|
|
37
76
|
___
|
|
38
77
|
|
|
39
78
|
### extraConfigs
|
|
40
79
|
|
|
41
80
|
• `Optional` **extraConfigs**: ``ExtraConfigs``
|
|
42
81
|
|
|
82
|
+
Extra configuration settings for different session types (e.g., mobile)
|
|
83
|
+
|
|
84
|
+
#### Implementation of
|
|
85
|
+
|
|
86
|
+
`CreateSessionParamsConfig`.`extraConfigs`
|
|
87
|
+
|
|
43
88
|
___
|
|
44
89
|
|
|
45
90
|
### framework
|
|
46
91
|
|
|
47
92
|
• `Optional` **framework**: `string`
|
|
48
93
|
|
|
94
|
+
Framework name for SDK statistics tracking
|
|
95
|
+
|
|
96
|
+
#### Implementation of
|
|
97
|
+
|
|
98
|
+
`CreateSessionParamsConfig`.`framework`
|
|
99
|
+
|
|
49
100
|
___
|
|
50
101
|
|
|
51
102
|
### imageId
|
|
52
103
|
|
|
53
104
|
• `Optional` **imageId**: `string`
|
|
54
105
|
|
|
106
|
+
Image ID to use for the session.
|
|
107
|
+
|
|
108
|
+
#### Implementation of
|
|
109
|
+
|
|
110
|
+
`CreateSessionParamsConfig`.`imageId`
|
|
111
|
+
|
|
55
112
|
___
|
|
56
113
|
|
|
57
|
-
|
|
114
|
+
#### Implementation of
|
|
58
115
|
|
|
59
|
-
|
|
116
|
+
`CreateSessionParamsConfig`.`isVpc`
|
|
60
117
|
|
|
61
118
|
___
|
|
62
119
|
|
|
63
|
-
|
|
120
|
+
#### Implementation of
|
|
64
121
|
|
|
65
|
-
|
|
122
|
+
`CreateSessionParamsConfig`.`labels`
|
|
66
123
|
|
|
67
124
|
___
|
|
68
125
|
|
|
69
126
|
### policyId
|
|
70
127
|
|
|
71
128
|
• `Optional` **policyId**: `string`
|
|
129
|
+
|
|
130
|
+
Policy id to apply when creating the session.
|
|
131
|
+
|
|
132
|
+
#### Implementation of
|
|
133
|
+
|
|
134
|
+
`CreateSessionParamsConfig`.`policyId`
|
|
135
|
+
|
|
136
|
+
## Methods
|
|
137
|
+
|
|
138
|
+
### addContextSync
|
|
139
|
+
|
|
140
|
+
▸ **addContextSync**(`contextId`, `path`, `policy?`): [`CreateSessionParams`](session-params.md)
|
|
141
|
+
|
|
142
|
+
AddContextSync adds a context sync configuration to the session parameters.
|
|
143
|
+
|
|
144
|
+
#### Parameters
|
|
145
|
+
|
|
146
|
+
| Name | Type |
|
|
147
|
+
| :------ | :------ |
|
|
148
|
+
| `contextId` | `string` |
|
|
149
|
+
| `path` | `string` |
|
|
150
|
+
| `policy?` | ``SyncPolicy`` |
|
|
151
|
+
|
|
152
|
+
#### Returns
|
|
153
|
+
|
|
154
|
+
[`CreateSessionParams`](session-params.md)
|
|
155
|
+
|
|
156
|
+
___
|
|
157
|
+
|
|
158
|
+
### addContextSyncConfig
|
|
159
|
+
|
|
160
|
+
▸ **addContextSyncConfig**(`contextSync`): [`CreateSessionParams`](session-params.md)
|
|
161
|
+
|
|
162
|
+
AddContextSyncConfig adds a pre-configured context sync to the session parameters.
|
|
163
|
+
|
|
164
|
+
#### Parameters
|
|
165
|
+
|
|
166
|
+
| Name | Type |
|
|
167
|
+
| :------ | :------ |
|
|
168
|
+
| `contextSync` | [`ContextSync`](context-sync.md) |
|
|
169
|
+
|
|
170
|
+
#### Returns
|
|
171
|
+
|
|
172
|
+
[`CreateSessionParams`](session-params.md)
|
|
173
|
+
|
|
174
|
+
___
|
|
175
|
+
|
|
176
|
+
### fromJSON
|
|
177
|
+
|
|
178
|
+
▸ **fromJSON**(`config`): [`CreateSessionParams`](session-params.md)
|
|
179
|
+
|
|
180
|
+
Create from plain object
|
|
181
|
+
|
|
182
|
+
#### Parameters
|
|
183
|
+
|
|
184
|
+
| Name | Type |
|
|
185
|
+
| :------ | :------ |
|
|
186
|
+
| `config` | ``CreateSessionParamsConfig`` |
|
|
187
|
+
|
|
188
|
+
#### Returns
|
|
189
|
+
|
|
190
|
+
[`CreateSessionParams`](session-params.md)
|
|
191
|
+
|
|
192
|
+
___
|
|
193
|
+
|
|
194
|
+
### toJSON
|
|
195
|
+
|
|
196
|
+
▸ **toJSON**(): ``CreateSessionParamsConfig``
|
|
197
|
+
|
|
198
|
+
Convert to plain object for JSON serialization
|
|
199
|
+
|
|
200
|
+
#### Returns
|
|
201
|
+
|
|
202
|
+
``CreateSessionParamsConfig``
|
|
203
|
+
|
|
204
|
+
___
|
|
205
|
+
|
|
206
|
+
### withBrowserContext
|
|
207
|
+
|
|
208
|
+
▸ **withBrowserContext**(`browserContext`): [`CreateSessionParams`](session-params.md)
|
|
209
|
+
|
|
210
|
+
WithBrowserContext sets the browser context for the session parameters and returns the updated parameters.
|
|
211
|
+
|
|
212
|
+
#### Parameters
|
|
213
|
+
|
|
214
|
+
| Name | Type |
|
|
215
|
+
| :------ | :------ |
|
|
216
|
+
| `browserContext` | ``BrowserContext`` |
|
|
217
|
+
|
|
218
|
+
#### Returns
|
|
219
|
+
|
|
220
|
+
[`CreateSessionParams`](session-params.md)
|
|
221
|
+
|
|
222
|
+
___
|
|
223
|
+
|
|
224
|
+
### withContextSync
|
|
225
|
+
|
|
226
|
+
▸ **withContextSync**(`contextSyncs`): [`CreateSessionParams`](session-params.md)
|
|
227
|
+
|
|
228
|
+
WithContextSync sets the context sync configurations for the session parameters.
|
|
229
|
+
|
|
230
|
+
#### Parameters
|
|
231
|
+
|
|
232
|
+
| Name | Type |
|
|
233
|
+
| :------ | :------ |
|
|
234
|
+
| `contextSyncs` | [`ContextSync`](context-sync.md)[] |
|
|
235
|
+
|
|
236
|
+
#### Returns
|
|
237
|
+
|
|
238
|
+
[`CreateSessionParams`](session-params.md)
|
|
239
|
+
|
|
240
|
+
___
|
|
241
|
+
|
|
242
|
+
### withEnableBrowserReplay
|
|
243
|
+
|
|
244
|
+
▸ **withEnableBrowserReplay**(`enableBrowserReplay`): [`CreateSessionParams`](session-params.md)
|
|
245
|
+
|
|
246
|
+
WithenableBrowserReplay sets the browser recording flag for the session parameters and returns the updated parameters.
|
|
247
|
+
|
|
248
|
+
#### Parameters
|
|
249
|
+
|
|
250
|
+
| Name | Type |
|
|
251
|
+
| :------ | :------ |
|
|
252
|
+
| `enableBrowserReplay` | `boolean` |
|
|
253
|
+
|
|
254
|
+
#### Returns
|
|
255
|
+
|
|
256
|
+
[`CreateSessionParams`](session-params.md)
|
|
257
|
+
|
|
258
|
+
___
|
|
259
|
+
|
|
260
|
+
### withEnableRecord
|
|
261
|
+
|
|
262
|
+
▸ **withEnableRecord**(`enableRecord`): [`CreateSessionParams`](session-params.md)
|
|
263
|
+
|
|
264
|
+
Alias for withEnableBrowserReplay for backward compatibility.
|
|
265
|
+
|
|
266
|
+
#### Parameters
|
|
267
|
+
|
|
268
|
+
| Name | Type |
|
|
269
|
+
| :------ | :------ |
|
|
270
|
+
| `enableRecord` | `boolean` |
|
|
271
|
+
|
|
272
|
+
#### Returns
|
|
273
|
+
|
|
274
|
+
[`CreateSessionParams`](session-params.md)
|
|
275
|
+
|
|
276
|
+
___
|
|
277
|
+
|
|
278
|
+
### withExtraConfigs
|
|
279
|
+
|
|
280
|
+
▸ **withExtraConfigs**(`extraConfigs`): [`CreateSessionParams`](session-params.md)
|
|
281
|
+
|
|
282
|
+
WithExtraConfigs sets the extra configurations for the session parameters and returns the updated parameters.
|
|
283
|
+
|
|
284
|
+
#### Parameters
|
|
285
|
+
|
|
286
|
+
| Name | Type |
|
|
287
|
+
| :------ | :------ |
|
|
288
|
+
| `extraConfigs` | ``ExtraConfigs`` |
|
|
289
|
+
|
|
290
|
+
#### Returns
|
|
291
|
+
|
|
292
|
+
[`CreateSessionParams`](session-params.md)
|
|
293
|
+
|
|
294
|
+
___
|
|
295
|
+
|
|
296
|
+
### withFramework
|
|
297
|
+
|
|
298
|
+
▸ **withFramework**(`framework`): [`CreateSessionParams`](session-params.md)
|
|
299
|
+
|
|
300
|
+
WithFramework sets the framework name for the session parameters and returns the updated parameters.
|
|
301
|
+
|
|
302
|
+
#### Parameters
|
|
303
|
+
|
|
304
|
+
| Name | Type |
|
|
305
|
+
| :------ | :------ |
|
|
306
|
+
| `framework` | `string` |
|
|
307
|
+
|
|
308
|
+
#### Returns
|
|
309
|
+
|
|
310
|
+
[`CreateSessionParams`](session-params.md)
|
|
311
|
+
|
|
312
|
+
___
|
|
313
|
+
|
|
314
|
+
### withImageId
|
|
315
|
+
|
|
316
|
+
▸ **withImageId**(`imageId`): [`CreateSessionParams`](session-params.md)
|
|
317
|
+
|
|
318
|
+
WithImageId sets the image ID for the session parameters and returns the updated parameters.
|
|
319
|
+
|
|
320
|
+
#### Parameters
|
|
321
|
+
|
|
322
|
+
| Name | Type |
|
|
323
|
+
| :------ | :------ |
|
|
324
|
+
| `imageId` | `string` |
|
|
325
|
+
|
|
326
|
+
#### Returns
|
|
327
|
+
|
|
328
|
+
[`CreateSessionParams`](session-params.md)
|
|
329
|
+
|
|
330
|
+
___
|
|
331
|
+
|
|
332
|
+
### withIsVpc
|
|
333
|
+
|
|
334
|
+
▸ **withIsVpc**(`isVpc`): [`CreateSessionParams`](session-params.md)
|
|
335
|
+
|
|
336
|
+
WithIsVpc sets the VPC flag for the session parameters and returns the updated parameters.
|
|
337
|
+
|
|
338
|
+
#### Parameters
|
|
339
|
+
|
|
340
|
+
| Name | Type |
|
|
341
|
+
| :------ | :------ |
|
|
342
|
+
| `isVpc` | `boolean` |
|
|
343
|
+
|
|
344
|
+
#### Returns
|
|
345
|
+
|
|
346
|
+
[`CreateSessionParams`](session-params.md)
|
|
347
|
+
|
|
348
|
+
___
|
|
349
|
+
|
|
350
|
+
### withLabels
|
|
351
|
+
|
|
352
|
+
▸ **withLabels**(`labels`): [`CreateSessionParams`](session-params.md)
|
|
353
|
+
|
|
354
|
+
WithLabels sets the labels for the session parameters and returns the updated parameters.
|
|
355
|
+
|
|
356
|
+
#### Parameters
|
|
357
|
+
|
|
358
|
+
| Name | Type |
|
|
359
|
+
| :------ | :------ |
|
|
360
|
+
| `labels` | `Record`\<`string`, `string`\> |
|
|
361
|
+
|
|
362
|
+
#### Returns
|
|
363
|
+
|
|
364
|
+
[`CreateSessionParams`](session-params.md)
|
|
365
|
+
|
|
366
|
+
___
|
|
367
|
+
|
|
368
|
+
### withPolicyId
|
|
369
|
+
|
|
370
|
+
▸ **withPolicyId**(`policyId`): [`CreateSessionParams`](session-params.md)
|
|
371
|
+
|
|
372
|
+
WithPolicyId sets the policy id for the session parameters and returns the updated parameters.
|
|
373
|
+
|
|
374
|
+
#### Parameters
|
|
375
|
+
|
|
376
|
+
| Name | Type |
|
|
377
|
+
| :------ | :------ |
|
|
378
|
+
| `policyId` | `string` |
|
|
379
|
+
|
|
380
|
+
#### Returns
|
|
381
|
+
|
|
382
|
+
[`CreateSessionParams`](session-params.md)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "test-wuying-agentbay-sdk",
|
|
3
|
-
"version": "0.13.0-beta.
|
|
3
|
+
"version": "0.13.0-beta.20251218114222",
|
|
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",
|