plato-sandbox-sdk 1.1.1

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 (203) hide show
  1. package/BaseClient.ts +28 -0
  2. package/Client.ts +1849 -0
  3. package/README.md +339 -0
  4. package/api/client/index.ts +1 -0
  5. package/api/client/requests/CreateSandboxRequest.ts +37 -0
  6. package/api/client/requests/CreateSnapshotRequest.ts +11 -0
  7. package/api/client/requests/EvaluateRequest.ts +9 -0
  8. package/api/client/requests/GetEnvironmentStateRequest.ts +11 -0
  9. package/api/client/requests/GetTestCasesRequest.ts +15 -0
  10. package/api/client/requests/LogRequest.ts +19 -0
  11. package/api/client/requests/MakeEnvironmentRequest.ts +27 -0
  12. package/api/client/requests/PostEvaluationResultRequest.ts +14 -0
  13. package/api/client/requests/ResetEnvironmentRequest.ts +11 -0
  14. package/api/client/requests/SetupRootAccessRequest.ts +14 -0
  15. package/api/client/requests/SetupSandboxRequest.ts +29 -0
  16. package/api/client/requests/StartWorkerRequest.ts +28 -0
  17. package/api/client/requests/index.ts +12 -0
  18. package/api/errors/BadRequestError.ts +17 -0
  19. package/api/errors/index.ts +1 -0
  20. package/api/index.ts +3 -0
  21. package/api/types/ActiveSessionResponse.ts +6 -0
  22. package/api/types/BackupEnvironmentResponse.ts +7 -0
  23. package/api/types/CdpUrlResponse.ts +12 -0
  24. package/api/types/CloseEnvironmentResponse.ts +6 -0
  25. package/api/types/CreateSandboxResponse.ts +14 -0
  26. package/api/types/CreateSnapshotResponse.ts +10 -0
  27. package/api/types/DeleteSandboxResponse.ts +6 -0
  28. package/api/types/Environment.ts +7 -0
  29. package/api/types/EnvironmentStateResponse.ts +11 -0
  30. package/api/types/ErrorResponse.ts +6 -0
  31. package/api/types/EvaluateResponse.ts +21 -0
  32. package/api/types/EvaluationResult.ts +9 -0
  33. package/api/types/HeartbeatResponse.ts +6 -0
  34. package/api/types/JobStatusResponse.ts +7 -0
  35. package/api/types/LogResponse.ts +5 -0
  36. package/api/types/MakeEnvironmentResponse.ts +6 -0
  37. package/api/types/OperationEvent.ts +42 -0
  38. package/api/types/PlatoConfig.ts +8 -0
  39. package/api/types/PlatoTask.ts +21 -0
  40. package/api/types/PlatoTaskMetadata.ts +20 -0
  41. package/api/types/PostEvaluationResultResponse.ts +6 -0
  42. package/api/types/ProxyUrlResponse.ts +12 -0
  43. package/api/types/ResetEnvironmentResponse.ts +13 -0
  44. package/api/types/RunningSessionsCountResponse.ts +6 -0
  45. package/api/types/Sandbox.ts +10 -0
  46. package/api/types/ScoringType.ts +7 -0
  47. package/api/types/SetupRootAccessResponse.ts +7 -0
  48. package/api/types/SetupSandboxResponse.ts +6 -0
  49. package/api/types/SimConfigCompute.ts +9 -0
  50. package/api/types/SimConfigDataset.ts +10 -0
  51. package/api/types/SimConfigListener.ts +27 -0
  52. package/api/types/SimConfigMetadata.ts +14 -0
  53. package/api/types/SimConfigService.ts +8 -0
  54. package/api/types/Simulator.ts +10 -0
  55. package/api/types/SimulatorListItem.ts +7 -0
  56. package/api/types/SshInfo.ts +18 -0
  57. package/api/types/StartWorkerResponse.ts +7 -0
  58. package/api/types/TaskMetadata.ts +20 -0
  59. package/api/types/TestCase.ts +40 -0
  60. package/api/types/TestCasesResponse.ts +10 -0
  61. package/api/types/Variable.ts +6 -0
  62. package/api/types/WorkerReadyResponse.ts +9 -0
  63. package/api/types/index.ts +42 -0
  64. package/core/fetcher/APIResponse.ts +23 -0
  65. package/core/fetcher/BinaryResponse.ts +36 -0
  66. package/core/fetcher/EndpointMetadata.ts +13 -0
  67. package/core/fetcher/EndpointSupplier.ts +14 -0
  68. package/core/fetcher/Fetcher.ts +165 -0
  69. package/core/fetcher/Headers.ts +93 -0
  70. package/core/fetcher/HttpResponsePromise.ts +116 -0
  71. package/core/fetcher/RawResponse.ts +61 -0
  72. package/core/fetcher/ResponseWithBody.ts +7 -0
  73. package/core/fetcher/Supplier.ts +11 -0
  74. package/core/fetcher/createRequestUrl.ts +6 -0
  75. package/core/fetcher/getErrorResponseBody.ts +33 -0
  76. package/core/fetcher/getFetchFn.ts +3 -0
  77. package/core/fetcher/getHeader.ts +8 -0
  78. package/core/fetcher/getRequestBody.ts +16 -0
  79. package/core/fetcher/getResponseBody.ts +43 -0
  80. package/core/fetcher/index.ts +11 -0
  81. package/core/fetcher/makeRequest.ts +44 -0
  82. package/core/fetcher/requestWithRetries.ts +73 -0
  83. package/core/fetcher/signals.ts +38 -0
  84. package/core/headers.ts +33 -0
  85. package/core/index.ts +4 -0
  86. package/core/json.ts +27 -0
  87. package/core/runtime/index.ts +1 -0
  88. package/core/runtime/runtime.ts +133 -0
  89. package/core/stream/Stream.ts +155 -0
  90. package/core/stream/index.ts +1 -0
  91. package/core/url/encodePathParam.ts +18 -0
  92. package/core/url/index.ts +3 -0
  93. package/core/url/join.ts +80 -0
  94. package/core/url/qs.ts +74 -0
  95. package/dist/BaseClient.d.ts +25 -0
  96. package/dist/Client.d.ts +376 -0
  97. package/dist/api/client/index.d.ts +2 -0
  98. package/dist/api/client/requests/CreateSandboxRequest.d.ts +35 -0
  99. package/dist/api/client/requests/CreateSnapshotRequest.d.ts +10 -0
  100. package/dist/api/client/requests/EvaluateRequest.d.ts +8 -0
  101. package/dist/api/client/requests/GetEnvironmentStateRequest.d.ts +10 -0
  102. package/dist/api/client/requests/GetTestCasesRequest.d.ts +14 -0
  103. package/dist/api/client/requests/LogRequest.d.ts +18 -0
  104. package/dist/api/client/requests/MakeEnvironmentRequest.d.ts +26 -0
  105. package/dist/api/client/requests/PostEvaluationResultRequest.d.ts +13 -0
  106. package/dist/api/client/requests/ResetEnvironmentRequest.d.ts +10 -0
  107. package/dist/api/client/requests/SetupRootAccessRequest.d.ts +13 -0
  108. package/dist/api/client/requests/SetupSandboxRequest.d.ts +27 -0
  109. package/dist/api/client/requests/StartWorkerRequest.d.ts +26 -0
  110. package/dist/api/client/requests/index.d.ts +13 -0
  111. package/dist/api/errors/BadRequestError.d.ts +7 -0
  112. package/dist/api/errors/index.d.ts +2 -0
  113. package/dist/api/index.d.ts +4 -0
  114. package/dist/api/types/ActiveSessionResponse.d.ts +5 -0
  115. package/dist/api/types/BackupEnvironmentResponse.d.ts +6 -0
  116. package/dist/api/types/CdpUrlResponse.d.ts +10 -0
  117. package/dist/api/types/CloseEnvironmentResponse.d.ts +5 -0
  118. package/dist/api/types/CreateSandboxResponse.d.ts +13 -0
  119. package/dist/api/types/CreateSnapshotResponse.d.ts +9 -0
  120. package/dist/api/types/DeleteSandboxResponse.d.ts +5 -0
  121. package/dist/api/types/Environment.d.ts +6 -0
  122. package/dist/api/types/EnvironmentStateResponse.d.ts +9 -0
  123. package/dist/api/types/ErrorResponse.d.ts +5 -0
  124. package/dist/api/types/EvaluateResponse.d.ts +18 -0
  125. package/dist/api/types/EvaluationResult.d.ts +8 -0
  126. package/dist/api/types/HeartbeatResponse.d.ts +5 -0
  127. package/dist/api/types/JobStatusResponse.d.ts +6 -0
  128. package/dist/api/types/LogResponse.d.ts +4 -0
  129. package/dist/api/types/MakeEnvironmentResponse.d.ts +5 -0
  130. package/dist/api/types/OperationEvent.d.ts +40 -0
  131. package/dist/api/types/PlatoConfig.d.ts +6 -0
  132. package/dist/api/types/PlatoTask.d.ts +19 -0
  133. package/dist/api/types/PlatoTaskMetadata.d.ts +18 -0
  134. package/dist/api/types/PostEvaluationResultResponse.d.ts +5 -0
  135. package/dist/api/types/ProxyUrlResponse.d.ts +10 -0
  136. package/dist/api/types/ResetEnvironmentResponse.d.ts +11 -0
  137. package/dist/api/types/RunningSessionsCountResponse.d.ts +5 -0
  138. package/dist/api/types/Sandbox.d.ts +9 -0
  139. package/dist/api/types/ScoringType.d.ts +6 -0
  140. package/dist/api/types/SetupRootAccessResponse.d.ts +6 -0
  141. package/dist/api/types/SetupSandboxResponse.d.ts +5 -0
  142. package/dist/api/types/SimConfigCompute.d.ts +8 -0
  143. package/dist/api/types/SimConfigDataset.d.ts +8 -0
  144. package/dist/api/types/SimConfigListener.d.ts +25 -0
  145. package/dist/api/types/SimConfigMetadata.d.ts +12 -0
  146. package/dist/api/types/SimConfigService.d.ts +7 -0
  147. package/dist/api/types/Simulator.d.ts +9 -0
  148. package/dist/api/types/SimulatorListItem.d.ts +6 -0
  149. package/dist/api/types/SshInfo.d.ts +17 -0
  150. package/dist/api/types/StartWorkerResponse.d.ts +6 -0
  151. package/dist/api/types/TaskMetadata.d.ts +18 -0
  152. package/dist/api/types/TestCase.d.ts +34 -0
  153. package/dist/api/types/TestCasesResponse.d.ts +8 -0
  154. package/dist/api/types/Variable.d.ts +5 -0
  155. package/dist/api/types/WorkerReadyResponse.d.ts +8 -0
  156. package/dist/api/types/index.d.ts +43 -0
  157. package/dist/core/fetcher/APIResponse.d.ts +21 -0
  158. package/dist/core/fetcher/BinaryResponse.d.ts +21 -0
  159. package/dist/core/fetcher/EndpointMetadata.d.ts +14 -0
  160. package/dist/core/fetcher/EndpointSupplier.d.ts +13 -0
  161. package/dist/core/fetcher/Fetcher.d.ts +43 -0
  162. package/dist/core/fetcher/Headers.d.ts +3 -0
  163. package/dist/core/fetcher/HttpResponsePromise.d.ts +59 -0
  164. package/dist/core/fetcher/RawResponse.d.ts +30 -0
  165. package/dist/core/fetcher/ResponseWithBody.d.ts +5 -0
  166. package/dist/core/fetcher/Supplier.d.ts +5 -0
  167. package/dist/core/fetcher/createRequestUrl.d.ts +2 -0
  168. package/dist/core/fetcher/getErrorResponseBody.d.ts +2 -0
  169. package/dist/core/fetcher/getFetchFn.d.ts +2 -0
  170. package/dist/core/fetcher/getHeader.d.ts +2 -0
  171. package/dist/core/fetcher/getRequestBody.d.ts +8 -0
  172. package/dist/core/fetcher/getResponseBody.d.ts +2 -0
  173. package/dist/core/fetcher/index.d.ts +12 -0
  174. package/dist/core/fetcher/makeRequest.d.ts +2 -0
  175. package/dist/core/fetcher/requestWithRetries.d.ts +2 -0
  176. package/dist/core/fetcher/signals.d.ts +12 -0
  177. package/dist/core/headers.d.ts +3 -0
  178. package/dist/core/index.d.ts +5 -0
  179. package/dist/core/json.d.ts +16 -0
  180. package/dist/core/runtime/index.d.ts +2 -0
  181. package/dist/core/runtime/runtime.d.ts +10 -0
  182. package/dist/core/stream/Stream.d.ts +48 -0
  183. package/dist/core/stream/index.d.ts +2 -0
  184. package/dist/core/url/encodePathParam.d.ts +2 -0
  185. package/dist/core/url/index.d.ts +4 -0
  186. package/dist/core/url/join.d.ts +2 -0
  187. package/dist/core/url/qs.d.ts +7 -0
  188. package/dist/errors/ApiError.d.ts +13 -0
  189. package/dist/errors/ApiTimeoutError.d.ts +4 -0
  190. package/dist/errors/index.d.ts +3 -0
  191. package/dist/helpers/SandboxHelpers.d.ts +127 -0
  192. package/dist/helpers/SandboxMonitor.d.ts +89 -0
  193. package/dist/helpers/index.d.ts +9 -0
  194. package/dist/index.d.ts +6 -0
  195. package/errors/ApiError.ts +53 -0
  196. package/errors/ApiTimeoutError.ts +8 -0
  197. package/errors/index.ts +2 -0
  198. package/helpers/README.md +229 -0
  199. package/helpers/SandboxHelpers.ts +213 -0
  200. package/helpers/SandboxMonitor.ts +252 -0
  201. package/helpers/index.ts +10 -0
  202. package/index.ts +7 -0
  203. package/package.json +54 -0
@@ -0,0 +1,376 @@
1
+ import * as Api from "./api/index.js";
2
+ import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
3
+ import * as core from "./core/index.js";
4
+ export declare namespace ApiClient {
5
+ interface Options extends BaseClientOptions {
6
+ }
7
+ interface RequestOptions extends BaseRequestOptions {
8
+ }
9
+ }
10
+ export declare class ApiClient {
11
+ protected readonly _options: ApiClient.Options;
12
+ constructor(_options: ApiClient.Options);
13
+ /**
14
+ * @param {Api.MakeEnvironmentRequest} request
15
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
16
+ *
17
+ * @throws {@link Api.BadRequestError}
18
+ *
19
+ * @example
20
+ * await client.makeEnvironment({
21
+ * interface_type: "interface_type",
22
+ * env_id: "env_id"
23
+ * })
24
+ */
25
+ makeEnvironment(request: Api.MakeEnvironmentRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.MakeEnvironmentResponse>;
26
+ private __makeEnvironment;
27
+ /**
28
+ * @param {string} jobId
29
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
30
+ *
31
+ * @throws {@link Api.BadRequestError}
32
+ *
33
+ * @example
34
+ * await client.getJobStatus("job_id")
35
+ */
36
+ getJobStatus(jobId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.JobStatusResponse>;
37
+ private __getJobStatus;
38
+ /**
39
+ * @param {string} jobId
40
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
41
+ *
42
+ * @throws {@link Api.BadRequestError}
43
+ *
44
+ * @example
45
+ * await client.getCdpUrl("job_id")
46
+ */
47
+ getCdpUrl(jobId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.CdpUrlResponse>;
48
+ private __getCdpUrl;
49
+ /**
50
+ * @param {string} jobId
51
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
52
+ *
53
+ * @throws {@link Api.BadRequestError}
54
+ *
55
+ * @example
56
+ * await client.getProxyUrl("job_id")
57
+ */
58
+ getProxyUrl(jobId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.ProxyUrlResponse>;
59
+ private __getProxyUrl;
60
+ /**
61
+ * @param {string} jobId
62
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
63
+ *
64
+ * @throws {@link Api.BadRequestError}
65
+ *
66
+ * @example
67
+ * await client.closeEnvironment("job_id")
68
+ */
69
+ closeEnvironment(jobId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.CloseEnvironmentResponse>;
70
+ private __closeEnvironment;
71
+ /**
72
+ * @param {string} jobId
73
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
74
+ *
75
+ * @throws {@link Api.BadRequestError}
76
+ *
77
+ * @example
78
+ * await client.backupEnvironment("job_id")
79
+ */
80
+ backupEnvironment(jobId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.BackupEnvironmentResponse>;
81
+ private __backupEnvironment;
82
+ /**
83
+ * @param {string} jobId
84
+ * @param {Api.ResetEnvironmentRequest} request
85
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
86
+ *
87
+ * @throws {@link Api.BadRequestError}
88
+ *
89
+ * @example
90
+ * await client.resetEnvironment("job_id")
91
+ */
92
+ resetEnvironment(jobId: string, request?: Api.ResetEnvironmentRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.ResetEnvironmentResponse>;
93
+ private __resetEnvironment;
94
+ /**
95
+ * @param {string} jobId
96
+ * @param {Api.GetEnvironmentStateRequest} request
97
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
98
+ *
99
+ * @throws {@link Api.BadRequestError}
100
+ *
101
+ * @example
102
+ * await client.getEnvironmentState("job_id", {
103
+ * merge_mutations: true
104
+ * })
105
+ */
106
+ getEnvironmentState(jobId: string, request?: Api.GetEnvironmentStateRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.EnvironmentStateResponse>;
107
+ private __getEnvironmentState;
108
+ /**
109
+ * @param {string} jobId
110
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
111
+ *
112
+ * @throws {@link Api.BadRequestError}
113
+ *
114
+ * @example
115
+ * await client.getWorkerReady("job_id")
116
+ */
117
+ getWorkerReady(jobId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.WorkerReadyResponse>;
118
+ private __getWorkerReady;
119
+ /**
120
+ * @param {string} jobId
121
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
122
+ *
123
+ * @throws {@link Api.BadRequestError}
124
+ *
125
+ * @example
126
+ * await client.sendHeartbeat("job_id")
127
+ */
128
+ sendHeartbeat(jobId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.HeartbeatResponse>;
129
+ private __sendHeartbeat;
130
+ /**
131
+ * @param {string} jobId
132
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
133
+ *
134
+ * @throws {@link Api.BadRequestError}
135
+ *
136
+ * @example
137
+ * await client.getActiveSession("job_id")
138
+ */
139
+ getActiveSession(jobId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.ActiveSessionResponse>;
140
+ private __getActiveSession;
141
+ /**
142
+ * @param {string} sessionId
143
+ * @param {Api.EvaluateRequest} request
144
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
145
+ *
146
+ * @throws {@link Api.BadRequestError}
147
+ *
148
+ * @example
149
+ * await client.evaluateSession("session_id")
150
+ */
151
+ evaluateSession(sessionId: string, request?: Api.EvaluateRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.EvaluateResponse>;
152
+ private __evaluateSession;
153
+ /**
154
+ * @param {string} sessionId
155
+ * @param {Api.PostEvaluationResultRequest} request
156
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
157
+ *
158
+ * @throws {@link Api.BadRequestError}
159
+ *
160
+ * @example
161
+ * await client.postEvaluationResult("session_id", {
162
+ * success: true
163
+ * })
164
+ */
165
+ postEvaluationResult(sessionId: string, request: Api.PostEvaluationResultRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.PostEvaluationResultResponse>;
166
+ private __postEvaluationResult;
167
+ /**
168
+ * @param {string} sessionId
169
+ * @param {Api.LogRequest} request
170
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
171
+ *
172
+ * @throws {@link Api.BadRequestError}
173
+ *
174
+ * @example
175
+ * await client.logMessage("session_id", {
176
+ * source: "source",
177
+ * type: "type",
178
+ * message: {
179
+ * "key": "value"
180
+ * },
181
+ * timestamp: "timestamp"
182
+ * })
183
+ */
184
+ logMessage(sessionId: string, request: Api.LogRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.LogResponse>;
185
+ private __logMessage;
186
+ /**
187
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
188
+ *
189
+ * @throws {@link Api.BadRequestError}
190
+ *
191
+ * @example
192
+ * await client.listSimulators()
193
+ */
194
+ listSimulators(requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.Simulator[]>;
195
+ private __listSimulators;
196
+ /**
197
+ * @param {Api.GetTestCasesRequest} request
198
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
199
+ *
200
+ * @throws {@link Api.BadRequestError}
201
+ *
202
+ * @example
203
+ * await client.getTestCases({
204
+ * simulator_name: "simulator_name",
205
+ * simulator_id: "simulator_id",
206
+ * page_size: 1
207
+ * })
208
+ */
209
+ getTestCases(request?: Api.GetTestCasesRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.TestCasesResponse>;
210
+ private __getTestCases;
211
+ /**
212
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
213
+ *
214
+ * @throws {@link Api.BadRequestError}
215
+ *
216
+ * @example
217
+ * await client.getRunningSessionsCount()
218
+ */
219
+ getRunningSessionsCount(requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.RunningSessionsCountResponse>;
220
+ private __getRunningSessionsCount;
221
+ /**
222
+ * Monitor the progress of long-running operations (sandbox creation, setup, etc.) via SSE.
223
+ *
224
+ * **Event Flow:**
225
+ * 1. First event: `type: "connected"` - Connection established, continue listening
226
+ * 2. Progress events: `type: "progress"` with `message` field - Operation updates
227
+ * 3. Completion: `type: "run_result"` or `"ssh_result"` - Operation finished
228
+ * - Check `success: true` for successful completion
229
+ * - Check `error` or `message` field if `success: false`
230
+ * 4. Error: `type: "error"` - Operation failed, check `error` or `message` field
231
+ *
232
+ * **Data Format:**
233
+ * SSE data is base64-encoded JSON. Decode it to get the OperationEvent object.
234
+ *
235
+ * **Client Implementation Required:**
236
+ * - Decode base64 data from each SSE event
237
+ * - Parse JSON to OperationEvent
238
+ * - Check event.type and event.success to determine operation status
239
+ * - Continue listening until receiving a terminal event (run_result, ssh_result, or error)
240
+ * - Return success/error based on the terminal event
241
+ *
242
+ * **Example (pseudo-code):**
243
+ * ```
244
+ * for event in stream:
245
+ * decoded = base64_decode(event.data)
246
+ * operation_event = json_parse(decoded)
247
+ *
248
+ * if operation_event.type == "connected":
249
+ * continue # Keep listening
250
+ * elif operation_event.type in ["run_result", "ssh_result"]:
251
+ * if operation_event.success:
252
+ * return SUCCESS
253
+ * else:
254
+ * return ERROR(operation_event.error || operation_event.message)
255
+ * elif operation_event.type == "error":
256
+ * return ERROR(operation_event.error || operation_event.message)
257
+ * ```
258
+ */
259
+ monitorOperation(correlationId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<core.Stream<Api.OperationEvent>>;
260
+ private __monitorOperation;
261
+ /**
262
+ * @param {Api.CreateSandboxRequest} request
263
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
264
+ *
265
+ * @throws {@link Api.BadRequestError}
266
+ *
267
+ * @example
268
+ * await client.createSandbox({
269
+ * dataset: "dataset",
270
+ * plato_dataset_config: {
271
+ * compute: {
272
+ * cpus: 1,
273
+ * memory: 1,
274
+ * disk: 1,
275
+ * app_port: 1,
276
+ * plato_messaging_port: 1
277
+ * },
278
+ * metadata: {
279
+ * name: "name"
280
+ * }
281
+ * }
282
+ * })
283
+ */
284
+ createSandbox(request: Api.CreateSandboxRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.CreateSandboxResponse>;
285
+ private __createSandbox;
286
+ /**
287
+ * @param {string} jobId
288
+ * @param {Api.SetupSandboxRequest} request
289
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
290
+ *
291
+ * @throws {@link Api.BadRequestError}
292
+ *
293
+ * @example
294
+ * await client.setupSandbox("job_id", {
295
+ * dataset: "dataset",
296
+ * plato_dataset_config: {
297
+ * compute: {
298
+ * cpus: 1,
299
+ * memory: 1,
300
+ * disk: 1,
301
+ * app_port: 1,
302
+ * plato_messaging_port: 1
303
+ * },
304
+ * metadata: {
305
+ * name: "name"
306
+ * }
307
+ * }
308
+ * })
309
+ */
310
+ setupSandbox(jobId: string, request: Api.SetupSandboxRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.SetupSandboxResponse>;
311
+ private __setupSandbox;
312
+ /**
313
+ * @param {string} publicId
314
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
315
+ *
316
+ * @throws {@link Api.BadRequestError}
317
+ *
318
+ * @example
319
+ * await client.deleteSandbox("public_id")
320
+ */
321
+ deleteSandbox(publicId: string, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.DeleteSandboxResponse>;
322
+ private __deleteSandbox;
323
+ /**
324
+ * @param {string} publicId
325
+ * @param {Api.CreateSnapshotRequest} request
326
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
327
+ *
328
+ * @throws {@link Api.BadRequestError}
329
+ *
330
+ * @example
331
+ * await client.createSnapshot("public_id")
332
+ */
333
+ createSnapshot(publicId: string, request?: Api.CreateSnapshotRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.CreateSnapshotResponse>;
334
+ private __createSnapshot;
335
+ /**
336
+ * @param {string} publicId
337
+ * @param {Api.StartWorkerRequest} request
338
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
339
+ *
340
+ * @throws {@link Api.BadRequestError}
341
+ *
342
+ * @example
343
+ * await client.startWorker("public_id", {
344
+ * dataset: "dataset",
345
+ * plato_dataset_config: {
346
+ * compute: {
347
+ * cpus: 1,
348
+ * memory: 1,
349
+ * disk: 1,
350
+ * app_port: 1,
351
+ * plato_messaging_port: 1
352
+ * },
353
+ * metadata: {
354
+ * name: "name"
355
+ * }
356
+ * }
357
+ * })
358
+ */
359
+ startWorker(publicId: string, request: Api.StartWorkerRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.StartWorkerResponse>;
360
+ private __startWorker;
361
+ /**
362
+ * @param {string} publicId
363
+ * @param {Api.SetupRootAccessRequest} request
364
+ * @param {ApiClient.RequestOptions} requestOptions - Request-specific configuration.
365
+ *
366
+ * @throws {@link Api.BadRequestError}
367
+ *
368
+ * @example
369
+ * await client.setupRootAccess("public_id", {
370
+ * ssh_public_key: "ssh_public_key"
371
+ * })
372
+ */
373
+ setupRootAccess(publicId: string, request: Api.SetupRootAccessRequest, requestOptions?: ApiClient.RequestOptions): core.HttpResponsePromise<Api.SetupRootAccessResponse>;
374
+ private __setupRootAccess;
375
+ }
376
+ //# sourceMappingURL=Client.d.ts.map
@@ -0,0 +1,2 @@
1
+ export * from "./requests/index.js";
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,35 @@
1
+ import type * as Api from "../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * dataset: "dataset",
6
+ * plato_dataset_config: {
7
+ * compute: {
8
+ * cpus: 1,
9
+ * memory: 1,
10
+ * disk: 1,
11
+ * app_port: 1,
12
+ * plato_messaging_port: 1
13
+ * },
14
+ * metadata: {
15
+ * name: "name"
16
+ * }
17
+ * }
18
+ * }
19
+ */
20
+ export interface CreateSandboxRequest {
21
+ /** Dataset name (e.g., "base") */
22
+ dataset: string;
23
+ plato_dataset_config: Api.SimConfigDataset;
24
+ /** Timeout in seconds for sandbox creation */
25
+ timeout?: number;
26
+ /** Wait time in seconds */
27
+ wait_time?: number;
28
+ /** Human-readable alias for the sandbox */
29
+ alias?: string;
30
+ /** Optional artifact ID to create sandbox from snapshot */
31
+ artifact_id?: string;
32
+ /** Service name */
33
+ service?: string;
34
+ }
35
+ //# sourceMappingURL=CreateSandboxRequest.d.ts.map
@@ -0,0 +1,10 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface CreateSnapshotRequest {
6
+ service?: string;
7
+ git_hash?: string;
8
+ dataset?: string;
9
+ }
10
+ //# sourceMappingURL=CreateSnapshotRequest.d.ts.map
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface EvaluateRequest {
6
+ value?: Record<string, unknown>;
7
+ }
8
+ //# sourceMappingURL=EvaluateRequest.d.ts.map
@@ -0,0 +1,10 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * merge_mutations: true
5
+ * }
6
+ */
7
+ export interface GetEnvironmentStateRequest {
8
+ merge_mutations?: boolean;
9
+ }
10
+ //# sourceMappingURL=GetEnvironmentStateRequest.d.ts.map
@@ -0,0 +1,14 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * simulator_name: "simulator_name",
5
+ * simulator_id: "simulator_id",
6
+ * page_size: 1
7
+ * }
8
+ */
9
+ export interface GetTestCasesRequest {
10
+ simulator_name?: string;
11
+ simulator_id?: string;
12
+ page_size?: number;
13
+ }
14
+ //# sourceMappingURL=GetTestCasesRequest.d.ts.map
@@ -0,0 +1,18 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * source: "source",
5
+ * type: "type",
6
+ * message: {
7
+ * "key": "value"
8
+ * },
9
+ * timestamp: "timestamp"
10
+ * }
11
+ */
12
+ export interface LogRequest {
13
+ source: string;
14
+ type: string;
15
+ message: Record<string, unknown>;
16
+ timestamp: string;
17
+ }
18
+ //# sourceMappingURL=LogRequest.d.ts.map
@@ -0,0 +1,26 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * interface_type: "interface_type",
5
+ * env_id: "env_id"
6
+ * }
7
+ */
8
+ export interface MakeEnvironmentRequest {
9
+ interface_type: string;
10
+ interface_width?: number;
11
+ interface_height?: number;
12
+ source?: string;
13
+ open_page_on_start?: boolean;
14
+ env_id: string;
15
+ tag?: string;
16
+ dataset?: string;
17
+ artifact_id?: string;
18
+ env_config?: Record<string, unknown>;
19
+ record_network_requests?: boolean;
20
+ record_actions?: boolean;
21
+ keepalive?: boolean;
22
+ alias?: string;
23
+ fast?: boolean;
24
+ version?: string;
25
+ }
26
+ //# sourceMappingURL=MakeEnvironmentRequest.d.ts.map
@@ -0,0 +1,13 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * success: true
5
+ * }
6
+ */
7
+ export interface PostEvaluationResultRequest {
8
+ success: boolean;
9
+ reason?: string;
10
+ agent_version?: string;
11
+ mutations?: Record<string, unknown>[];
12
+ }
13
+ //# sourceMappingURL=PostEvaluationResultRequest.d.ts.map
@@ -0,0 +1,10 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface ResetEnvironmentRequest {
6
+ test_case_public_id?: string;
7
+ agent_version?: string;
8
+ load_browser_state?: boolean;
9
+ }
10
+ //# sourceMappingURL=ResetEnvironmentRequest.d.ts.map
@@ -0,0 +1,13 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * ssh_public_key: "ssh_public_key"
5
+ * }
6
+ */
7
+ export interface SetupRootAccessRequest {
8
+ /** SSH public key to install for root user */
9
+ ssh_public_key: string;
10
+ /** Timeout in seconds */
11
+ timeout?: number;
12
+ }
13
+ //# sourceMappingURL=SetupRootAccessRequest.d.ts.map
@@ -0,0 +1,27 @@
1
+ import type * as Api from "../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * dataset: "dataset",
6
+ * plato_dataset_config: {
7
+ * compute: {
8
+ * cpus: 1,
9
+ * memory: 1,
10
+ * disk: 1,
11
+ * app_port: 1,
12
+ * plato_messaging_port: 1
13
+ * },
14
+ * metadata: {
15
+ * name: "name"
16
+ * }
17
+ * }
18
+ * }
19
+ */
20
+ export interface SetupSandboxRequest {
21
+ /** Dataset name */
22
+ dataset: string;
23
+ plato_dataset_config: Api.SimConfigDataset;
24
+ /** SSH public key to install for plato user */
25
+ ssh_public_key?: string;
26
+ }
27
+ //# sourceMappingURL=SetupSandboxRequest.d.ts.map
@@ -0,0 +1,26 @@
1
+ import type * as Api from "../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * dataset: "dataset",
6
+ * plato_dataset_config: {
7
+ * compute: {
8
+ * cpus: 1,
9
+ * memory: 1,
10
+ * disk: 1,
11
+ * app_port: 1,
12
+ * plato_messaging_port: 1
13
+ * },
14
+ * metadata: {
15
+ * name: "name"
16
+ * }
17
+ * }
18
+ * }
19
+ */
20
+ export interface StartWorkerRequest {
21
+ service?: string;
22
+ dataset: string;
23
+ plato_dataset_config: Api.SimConfigDataset;
24
+ timeout?: number;
25
+ }
26
+ //# sourceMappingURL=StartWorkerRequest.d.ts.map
@@ -0,0 +1,13 @@
1
+ export type { CreateSandboxRequest } from "./CreateSandboxRequest.js";
2
+ export type { CreateSnapshotRequest } from "./CreateSnapshotRequest.js";
3
+ export type { EvaluateRequest } from "./EvaluateRequest.js";
4
+ export type { GetEnvironmentStateRequest } from "./GetEnvironmentStateRequest.js";
5
+ export type { GetTestCasesRequest } from "./GetTestCasesRequest.js";
6
+ export type { LogRequest } from "./LogRequest.js";
7
+ export type { MakeEnvironmentRequest } from "./MakeEnvironmentRequest.js";
8
+ export type { PostEvaluationResultRequest } from "./PostEvaluationResultRequest.js";
9
+ export type { ResetEnvironmentRequest } from "./ResetEnvironmentRequest.js";
10
+ export type { SetupRootAccessRequest } from "./SetupRootAccessRequest.js";
11
+ export type { SetupSandboxRequest } from "./SetupSandboxRequest.js";
12
+ export type { StartWorkerRequest } from "./StartWorkerRequest.js";
13
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,7 @@
1
+ import type * as core from "../../core/index.js";
2
+ import * as errors from "../../errors/index.js";
3
+ import type * as Api from "../index.js";
4
+ export declare class BadRequestError extends errors.ApiError {
5
+ constructor(body: Api.ErrorResponse, rawResponse?: core.RawResponse);
6
+ }
7
+ //# sourceMappingURL=BadRequestError.d.ts.map
@@ -0,0 +1,2 @@
1
+ export * from "./BadRequestError.js";
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,4 @@
1
+ export * from "./client/index.js";
2
+ export * from "./errors/index.js";
3
+ export * from "./types/index.js";
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,5 @@
1
+ export interface ActiveSessionResponse {
2
+ session_id?: string;
3
+ error?: string;
4
+ }
5
+ //# sourceMappingURL=ActiveSessionResponse.d.ts.map
@@ -0,0 +1,6 @@
1
+ export interface BackupEnvironmentResponse {
2
+ success?: boolean;
3
+ message?: string;
4
+ data?: Record<string, unknown>;
5
+ }
6
+ //# sourceMappingURL=BackupEnvironmentResponse.d.ts.map
@@ -0,0 +1,10 @@
1
+ export interface CdpUrlResponse {
2
+ data?: CdpUrlResponse.Data;
3
+ error?: string;
4
+ }
5
+ export declare namespace CdpUrlResponse {
6
+ interface Data {
7
+ cdp_url?: string;
8
+ }
9
+ }
10
+ //# sourceMappingURL=CdpUrlResponse.d.ts.map
@@ -0,0 +1,5 @@
1
+ export interface CloseEnvironmentResponse {
2
+ success?: boolean;
3
+ message?: string;
4
+ }
5
+ //# sourceMappingURL=CloseEnvironmentResponse.d.ts.map