@onkernel/sdk 0.14.2 → 0.15.0
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/CHANGELOG.md +9 -0
- package/README.md +5 -17
- package/internal/uploads.js +20 -1
- package/internal/uploads.js.map +1 -1
- package/internal/uploads.mjs +20 -1
- package/internal/uploads.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/browsers/browsers.d.mts +4 -0
- package/resources/browsers/browsers.d.mts.map +1 -1
- package/resources/browsers/browsers.d.ts +4 -0
- package/resources/browsers/browsers.d.ts.map +1 -1
- package/resources/browsers/browsers.js +4 -0
- package/resources/browsers/browsers.js.map +1 -1
- package/resources/browsers/browsers.mjs +4 -0
- package/resources/browsers/browsers.mjs.map +1 -1
- package/resources/browsers/computer.d.mts +232 -0
- package/resources/browsers/computer.d.mts.map +1 -0
- package/resources/browsers/computer.d.ts +232 -0
- package/resources/browsers/computer.d.ts.map +1 -0
- package/resources/browsers/computer.js +136 -0
- package/resources/browsers/computer.js.map +1 -0
- package/resources/browsers/computer.mjs +132 -0
- package/resources/browsers/computer.mjs.map +1 -0
- package/resources/browsers/index.d.mts +1 -0
- package/resources/browsers/index.d.mts.map +1 -1
- package/resources/browsers/index.d.ts +1 -0
- package/resources/browsers/index.d.ts.map +1 -1
- package/resources/browsers/index.js +3 -1
- package/resources/browsers/index.js.map +1 -1
- package/resources/browsers/index.mjs +1 -0
- package/resources/browsers/index.mjs.map +1 -1
- package/resources/deployments.d.mts +58 -5
- package/resources/deployments.d.mts.map +1 -1
- package/resources/deployments.d.ts +58 -5
- package/resources/deployments.d.ts.map +1 -1
- package/resources/deployments.js +3 -0
- package/resources/deployments.js.map +1 -1
- package/resources/deployments.mjs +3 -0
- package/resources/deployments.mjs.map +1 -1
- package/src/internal/uploads.ts +21 -3
- package/src/resources/browsers/browsers.ts +24 -0
- package/src/resources/browsers/computer.ts +328 -0
- package/src/resources/browsers/index.ts +10 -0
- package/src/resources/deployments.ts +68 -6
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -13,7 +13,10 @@ export declare class Deployments extends APIResource {
|
|
|
13
13
|
* ```ts
|
|
14
14
|
* const deployment = await client.deployments.create({
|
|
15
15
|
* entrypoint_rel_path: 'src/app.py',
|
|
16
|
+
* env_vars: { FOO: 'bar' },
|
|
16
17
|
* file: fs.createReadStream('path/to/file'),
|
|
18
|
+
* region: 'aws.us-east-1a',
|
|
19
|
+
* version: '1.0.0',
|
|
17
20
|
* });
|
|
18
21
|
* ```
|
|
19
22
|
*/
|
|
@@ -276,11 +279,7 @@ export interface DeploymentCreateParams {
|
|
|
276
279
|
/**
|
|
277
280
|
* Relative path to the entrypoint of the application
|
|
278
281
|
*/
|
|
279
|
-
entrypoint_rel_path
|
|
280
|
-
/**
|
|
281
|
-
* ZIP file containing the application source directory
|
|
282
|
-
*/
|
|
283
|
-
file: Uploadable;
|
|
282
|
+
entrypoint_rel_path?: string;
|
|
284
283
|
/**
|
|
285
284
|
* Map of environment variables to set for the deployed application. Each key-value
|
|
286
285
|
* pair represents an environment variable.
|
|
@@ -288,6 +287,10 @@ export interface DeploymentCreateParams {
|
|
|
288
287
|
env_vars?: {
|
|
289
288
|
[key: string]: string;
|
|
290
289
|
};
|
|
290
|
+
/**
|
|
291
|
+
* ZIP file containing the application source directory
|
|
292
|
+
*/
|
|
293
|
+
file?: Uploadable;
|
|
291
294
|
/**
|
|
292
295
|
* Allow overwriting an existing app version
|
|
293
296
|
*/
|
|
@@ -296,11 +299,61 @@ export interface DeploymentCreateParams {
|
|
|
296
299
|
* Region for deployment. Currently we only support "aws.us-east-1a"
|
|
297
300
|
*/
|
|
298
301
|
region?: 'aws.us-east-1a';
|
|
302
|
+
/**
|
|
303
|
+
* Source from which to fetch application code.
|
|
304
|
+
*/
|
|
305
|
+
source?: DeploymentCreateParams.Source;
|
|
299
306
|
/**
|
|
300
307
|
* Version of the application. Can be any string.
|
|
301
308
|
*/
|
|
302
309
|
version?: string;
|
|
303
310
|
}
|
|
311
|
+
export declare namespace DeploymentCreateParams {
|
|
312
|
+
/**
|
|
313
|
+
* Source from which to fetch application code.
|
|
314
|
+
*/
|
|
315
|
+
interface Source {
|
|
316
|
+
/**
|
|
317
|
+
* Relative path to the application entrypoint within the selected path.
|
|
318
|
+
*/
|
|
319
|
+
entrypoint: string;
|
|
320
|
+
/**
|
|
321
|
+
* Git ref (branch, tag, or commit SHA) to fetch.
|
|
322
|
+
*/
|
|
323
|
+
ref: string;
|
|
324
|
+
/**
|
|
325
|
+
* Source type identifier.
|
|
326
|
+
*/
|
|
327
|
+
type: 'github';
|
|
328
|
+
/**
|
|
329
|
+
* Base repository URL (without blob/tree suffixes).
|
|
330
|
+
*/
|
|
331
|
+
url: string;
|
|
332
|
+
/**
|
|
333
|
+
* Authentication for private repositories.
|
|
334
|
+
*/
|
|
335
|
+
auth?: Source.Auth;
|
|
336
|
+
/**
|
|
337
|
+
* Path within the repo to deploy (omit to use repo root).
|
|
338
|
+
*/
|
|
339
|
+
path?: string;
|
|
340
|
+
}
|
|
341
|
+
namespace Source {
|
|
342
|
+
/**
|
|
343
|
+
* Authentication for private repositories.
|
|
344
|
+
*/
|
|
345
|
+
interface Auth {
|
|
346
|
+
/**
|
|
347
|
+
* GitHub PAT or installation access token
|
|
348
|
+
*/
|
|
349
|
+
token: string;
|
|
350
|
+
/**
|
|
351
|
+
* Auth method
|
|
352
|
+
*/
|
|
353
|
+
method: 'github_token';
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
}
|
|
304
357
|
export interface DeploymentListParams extends OffsetPaginationParams {
|
|
305
358
|
/**
|
|
306
359
|
* Filter results by application name.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deployments.d.mts","sourceRoot":"","sources":["../src/resources/deployments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE;OAC9D,EAAE,MAAM,EAAE;OACV,EAAE,KAAK,UAAU,EAAE;OAEnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"deployments.d.mts","sourceRoot":"","sources":["../src/resources/deployments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE;OAC9D,EAAE,MAAM,EAAE;OACV,EAAE,KAAK,UAAU,EAAE;OAEnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIpG;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAItF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,sBAAsB,CAAC;IAO/E;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,sBAAsB,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;CAQhD;AAED,MAAM,MAAM,uCAAuC,GAAG,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,gBAAgB,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;QAEpE;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAErC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEpE;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEpE;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEpE;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,MAAM,CAAC,QAAQ,GACf,oBAAoB,GACpB,wBAAwB,CAAC,sBAAsB,GAC/C,MAAM,CAAC,UAAU,GACjB,MAAM,CAAC,cAAc,CAAC;AAE1B,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,qBAAqB,CAAC;QAE7B;;WAEG;QACH,MAAM,EAAE,gBAAgB,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACtC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEvC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;QAEf;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;QAEnB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,MAAM,EAAE,cAAc,CAAC;SACxB;KACF;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;IAClE;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -13,7 +13,10 @@ export declare class Deployments extends APIResource {
|
|
|
13
13
|
* ```ts
|
|
14
14
|
* const deployment = await client.deployments.create({
|
|
15
15
|
* entrypoint_rel_path: 'src/app.py',
|
|
16
|
+
* env_vars: { FOO: 'bar' },
|
|
16
17
|
* file: fs.createReadStream('path/to/file'),
|
|
18
|
+
* region: 'aws.us-east-1a',
|
|
19
|
+
* version: '1.0.0',
|
|
17
20
|
* });
|
|
18
21
|
* ```
|
|
19
22
|
*/
|
|
@@ -276,11 +279,7 @@ export interface DeploymentCreateParams {
|
|
|
276
279
|
/**
|
|
277
280
|
* Relative path to the entrypoint of the application
|
|
278
281
|
*/
|
|
279
|
-
entrypoint_rel_path
|
|
280
|
-
/**
|
|
281
|
-
* ZIP file containing the application source directory
|
|
282
|
-
*/
|
|
283
|
-
file: Uploadable;
|
|
282
|
+
entrypoint_rel_path?: string;
|
|
284
283
|
/**
|
|
285
284
|
* Map of environment variables to set for the deployed application. Each key-value
|
|
286
285
|
* pair represents an environment variable.
|
|
@@ -288,6 +287,10 @@ export interface DeploymentCreateParams {
|
|
|
288
287
|
env_vars?: {
|
|
289
288
|
[key: string]: string;
|
|
290
289
|
};
|
|
290
|
+
/**
|
|
291
|
+
* ZIP file containing the application source directory
|
|
292
|
+
*/
|
|
293
|
+
file?: Uploadable;
|
|
291
294
|
/**
|
|
292
295
|
* Allow overwriting an existing app version
|
|
293
296
|
*/
|
|
@@ -296,11 +299,61 @@ export interface DeploymentCreateParams {
|
|
|
296
299
|
* Region for deployment. Currently we only support "aws.us-east-1a"
|
|
297
300
|
*/
|
|
298
301
|
region?: 'aws.us-east-1a';
|
|
302
|
+
/**
|
|
303
|
+
* Source from which to fetch application code.
|
|
304
|
+
*/
|
|
305
|
+
source?: DeploymentCreateParams.Source;
|
|
299
306
|
/**
|
|
300
307
|
* Version of the application. Can be any string.
|
|
301
308
|
*/
|
|
302
309
|
version?: string;
|
|
303
310
|
}
|
|
311
|
+
export declare namespace DeploymentCreateParams {
|
|
312
|
+
/**
|
|
313
|
+
* Source from which to fetch application code.
|
|
314
|
+
*/
|
|
315
|
+
interface Source {
|
|
316
|
+
/**
|
|
317
|
+
* Relative path to the application entrypoint within the selected path.
|
|
318
|
+
*/
|
|
319
|
+
entrypoint: string;
|
|
320
|
+
/**
|
|
321
|
+
* Git ref (branch, tag, or commit SHA) to fetch.
|
|
322
|
+
*/
|
|
323
|
+
ref: string;
|
|
324
|
+
/**
|
|
325
|
+
* Source type identifier.
|
|
326
|
+
*/
|
|
327
|
+
type: 'github';
|
|
328
|
+
/**
|
|
329
|
+
* Base repository URL (without blob/tree suffixes).
|
|
330
|
+
*/
|
|
331
|
+
url: string;
|
|
332
|
+
/**
|
|
333
|
+
* Authentication for private repositories.
|
|
334
|
+
*/
|
|
335
|
+
auth?: Source.Auth;
|
|
336
|
+
/**
|
|
337
|
+
* Path within the repo to deploy (omit to use repo root).
|
|
338
|
+
*/
|
|
339
|
+
path?: string;
|
|
340
|
+
}
|
|
341
|
+
namespace Source {
|
|
342
|
+
/**
|
|
343
|
+
* Authentication for private repositories.
|
|
344
|
+
*/
|
|
345
|
+
interface Auth {
|
|
346
|
+
/**
|
|
347
|
+
* GitHub PAT or installation access token
|
|
348
|
+
*/
|
|
349
|
+
token: string;
|
|
350
|
+
/**
|
|
351
|
+
* Auth method
|
|
352
|
+
*/
|
|
353
|
+
method: 'github_token';
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
}
|
|
304
357
|
export interface DeploymentListParams extends OffsetPaginationParams {
|
|
305
358
|
/**
|
|
306
359
|
* Filter results by application name.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deployments.d.ts","sourceRoot":"","sources":["../src/resources/deployments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE;OAC9D,EAAE,MAAM,EAAE;OACV,EAAE,KAAK,UAAU,EAAE;OAEnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"deployments.d.ts","sourceRoot":"","sources":["../src/resources/deployments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE;OAC9D,EAAE,MAAM,EAAE;OACV,EAAE,KAAK,UAAU,EAAE;OAEnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIpG;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAItF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,sBAAsB,CAAC;IAO/E;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,sBAAsB,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;CAQhD;AAED,MAAM,MAAM,uCAAuC,GAAG,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,gBAAgB,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;QAEpE;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAErC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEpE;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEpE;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAEpE;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,MAAM,CAAC,QAAQ,GACf,oBAAoB,GACpB,wBAAwB,CAAC,sBAAsB,GAC/C,MAAM,CAAC,UAAU,GACjB,MAAM,CAAC,cAAc,CAAC;AAE1B,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,EAAE,qBAAqB,CAAC;QAE7B;;WAEG;QACH,MAAM,EAAE,gBAAgB,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACtC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEvC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;QAEf;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;QAEnB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,MAAM,EAAE,cAAc,CAAC;SACxB;KACF;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;IAClE;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
package/resources/deployments.js
CHANGED
|
@@ -15,7 +15,10 @@ class Deployments extends resource_1.APIResource {
|
|
|
15
15
|
* ```ts
|
|
16
16
|
* const deployment = await client.deployments.create({
|
|
17
17
|
* entrypoint_rel_path: 'src/app.py',
|
|
18
|
+
* env_vars: { FOO: 'bar' },
|
|
18
19
|
* file: fs.createReadStream('path/to/file'),
|
|
20
|
+
* region: 'aws.us-east-1a',
|
|
21
|
+
* version: '1.0.0',
|
|
19
22
|
* });
|
|
20
23
|
* ```
|
|
21
24
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deployments.js","sourceRoot":"","sources":["../src/resources/deployments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgG;AAGhG,oDAAmD;AAEnD,oDAAkE;AAClE,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"deployments.js","sourceRoot":"","sources":["../src/resources/deployments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgG;AAGhG,oDAAmD;AAEnD,oDAAkE;AAClE,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAA,qCAA2B,EAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,6BAAwC,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,SAAS,EAAE;YACvD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1E,MAAM,EAAE,IAAI;SACb,CAAiD,CAAC;IACrD,CAAC;CACF;AA1ED,kCA0EC"}
|
|
@@ -12,7 +12,10 @@ export class Deployments extends APIResource {
|
|
|
12
12
|
* ```ts
|
|
13
13
|
* const deployment = await client.deployments.create({
|
|
14
14
|
* entrypoint_rel_path: 'src/app.py',
|
|
15
|
+
* env_vars: { FOO: 'bar' },
|
|
15
16
|
* file: fs.createReadStream('path/to/file'),
|
|
17
|
+
* region: 'aws.us-east-1a',
|
|
18
|
+
* version: '1.0.0',
|
|
16
19
|
* });
|
|
17
20
|
* ```
|
|
18
21
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deployments.mjs","sourceRoot":"","sources":["../src/resources/deployments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,gBAAgB,EAA4C;OAG9D,EAAE,YAAY,EAAE;OAEhB,EAAE,2BAA2B,EAAE;OAC/B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C
|
|
1
|
+
{"version":3,"file":"deployments.mjs","sourceRoot":"","sources":["../src/resources/deployments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,gBAAgB,EAA4C;OAG9D,EAAE,YAAY,EAAE;OAEhB,EAAE,2BAA2B,EAAE;OAC/B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,gBAAwC,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,EAAE,SAAS,EAAE;YACvD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1E,MAAM,EAAE,IAAI;SACb,CAAiD,CAAC;IACrD,CAAC;CACF"}
|
package/src/internal/uploads.ts
CHANGED
|
@@ -176,9 +176,27 @@ const addFormValue = async (form: FormData, key: string, value: unknown): Promis
|
|
|
176
176
|
} else if (Array.isArray(value)) {
|
|
177
177
|
await Promise.all(value.map((entry) => addFormValue(form, key + '[]', entry)));
|
|
178
178
|
} else if (typeof value === 'object') {
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
179
|
+
// Special case: env_vars should always be flattened for backward compatibility
|
|
180
|
+
// with APIs that expect env_vars[KEY] format
|
|
181
|
+
const shouldAlwaysFlatten = key === 'env_vars';
|
|
182
|
+
// If the object doesn't contain any uploadable values,
|
|
183
|
+
// serialize it as JSON instead of flattening it into bracketed keys.
|
|
184
|
+
// This handles fields with contentType: application/json in the OpenAPI spec.
|
|
185
|
+
if (!shouldAlwaysFlatten && !hasUploadableValue(value)) {
|
|
186
|
+
// Filter out undefined values to check if object has any actual content
|
|
187
|
+
const entries = Object.entries(value).filter(([_, v]) => v !== undefined);
|
|
188
|
+
if (entries.length > 0) {
|
|
189
|
+
form.append(key, JSON.stringify(value));
|
|
190
|
+
}
|
|
191
|
+
// If all properties are undefined, don't add anything to the form
|
|
192
|
+
} else {
|
|
193
|
+
// Flatten objects that:
|
|
194
|
+
// - Contain uploadable values (files/blobs), or
|
|
195
|
+
// - Are explicitly marked to always flatten (like env_vars)
|
|
196
|
+
await Promise.all(
|
|
197
|
+
Object.entries(value).map(([name, prop]) => addFormValue(form, `${key}[${name}]`, prop)),
|
|
198
|
+
);
|
|
199
|
+
}
|
|
182
200
|
} else {
|
|
183
201
|
throw new TypeError(
|
|
184
202
|
`Invalid value given to form, expected a string, number, boolean, object, Array, File or Blob but got ${value} instead`,
|
|
@@ -2,6 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../../core/resource';
|
|
4
4
|
import * as BrowsersAPI from './browsers';
|
|
5
|
+
import * as ComputerAPI from './computer';
|
|
6
|
+
import {
|
|
7
|
+
Computer,
|
|
8
|
+
ComputerCaptureScreenshotParams,
|
|
9
|
+
ComputerClickMouseParams,
|
|
10
|
+
ComputerDragMouseParams,
|
|
11
|
+
ComputerMoveMouseParams,
|
|
12
|
+
ComputerPressKeyParams,
|
|
13
|
+
ComputerScrollParams,
|
|
14
|
+
ComputerTypeTextParams,
|
|
15
|
+
} from './computer';
|
|
5
16
|
import * as LogsAPI from './logs';
|
|
6
17
|
import { LogStreamParams, Logs } from './logs';
|
|
7
18
|
import * as ProcessAPI from './process';
|
|
@@ -59,6 +70,7 @@ export class Browsers extends APIResource {
|
|
|
59
70
|
fs: FsAPI.Fs = new FsAPI.Fs(this._client);
|
|
60
71
|
process: ProcessAPI.Process = new ProcessAPI.Process(this._client);
|
|
61
72
|
logs: LogsAPI.Logs = new LogsAPI.Logs(this._client);
|
|
73
|
+
computer: ComputerAPI.Computer = new ComputerAPI.Computer(this._client);
|
|
62
74
|
|
|
63
75
|
/**
|
|
64
76
|
* Create a new browser session from within an action.
|
|
@@ -682,6 +694,7 @@ Browsers.Replays = Replays;
|
|
|
682
694
|
Browsers.Fs = Fs;
|
|
683
695
|
Browsers.Process = Process;
|
|
684
696
|
Browsers.Logs = Logs;
|
|
697
|
+
Browsers.Computer = Computer;
|
|
685
698
|
|
|
686
699
|
export declare namespace Browsers {
|
|
687
700
|
export {
|
|
@@ -739,4 +752,15 @@ export declare namespace Browsers {
|
|
|
739
752
|
};
|
|
740
753
|
|
|
741
754
|
export { Logs as Logs, type LogStreamParams as LogStreamParams };
|
|
755
|
+
|
|
756
|
+
export {
|
|
757
|
+
Computer as Computer,
|
|
758
|
+
type ComputerCaptureScreenshotParams as ComputerCaptureScreenshotParams,
|
|
759
|
+
type ComputerClickMouseParams as ComputerClickMouseParams,
|
|
760
|
+
type ComputerDragMouseParams as ComputerDragMouseParams,
|
|
761
|
+
type ComputerMoveMouseParams as ComputerMoveMouseParams,
|
|
762
|
+
type ComputerPressKeyParams as ComputerPressKeyParams,
|
|
763
|
+
type ComputerScrollParams as ComputerScrollParams,
|
|
764
|
+
type ComputerTypeTextParams as ComputerTypeTextParams,
|
|
765
|
+
};
|
|
742
766
|
}
|
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../core/resource';
|
|
4
|
+
import { APIPromise } from '../../core/api-promise';
|
|
5
|
+
import { buildHeaders } from '../../internal/headers';
|
|
6
|
+
import { RequestOptions } from '../../internal/request-options';
|
|
7
|
+
import { path } from '../../internal/utils/path';
|
|
8
|
+
|
|
9
|
+
export class Computer extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Capture a screenshot of the browser instance
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const response =
|
|
16
|
+
* await client.browsers.computer.captureScreenshot('id');
|
|
17
|
+
*
|
|
18
|
+
* const content = await response.blob();
|
|
19
|
+
* console.log(content);
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
captureScreenshot(
|
|
23
|
+
id: string,
|
|
24
|
+
body: ComputerCaptureScreenshotParams | null | undefined = {},
|
|
25
|
+
options?: RequestOptions,
|
|
26
|
+
): APIPromise<Response> {
|
|
27
|
+
return this._client.post(path`/browsers/${id}/computer/screenshot`, {
|
|
28
|
+
body,
|
|
29
|
+
...options,
|
|
30
|
+
headers: buildHeaders([{ Accept: 'image/png' }, options?.headers]),
|
|
31
|
+
__binaryResponse: true,
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Simulate a mouse click action on the browser instance
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* await client.browsers.computer.clickMouse('id', {
|
|
41
|
+
* x: 0,
|
|
42
|
+
* y: 0,
|
|
43
|
+
* });
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
clickMouse(id: string, body: ComputerClickMouseParams, options?: RequestOptions): APIPromise<void> {
|
|
47
|
+
return this._client.post(path`/browsers/${id}/computer/click_mouse`, {
|
|
48
|
+
body,
|
|
49
|
+
...options,
|
|
50
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Drag the mouse along a path
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* await client.browsers.computer.dragMouse('id', {
|
|
60
|
+
* path: [
|
|
61
|
+
* [0, 0],
|
|
62
|
+
* [0, 0],
|
|
63
|
+
* ],
|
|
64
|
+
* });
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
dragMouse(id: string, body: ComputerDragMouseParams, options?: RequestOptions): APIPromise<void> {
|
|
68
|
+
return this._client.post(path`/browsers/${id}/computer/drag_mouse`, {
|
|
69
|
+
body,
|
|
70
|
+
...options,
|
|
71
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Move the mouse cursor to the specified coordinates on the browser instance
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* await client.browsers.computer.moveMouse('id', {
|
|
81
|
+
* x: 0,
|
|
82
|
+
* y: 0,
|
|
83
|
+
* });
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
moveMouse(id: string, body: ComputerMoveMouseParams, options?: RequestOptions): APIPromise<void> {
|
|
87
|
+
return this._client.post(path`/browsers/${id}/computer/move_mouse`, {
|
|
88
|
+
body,
|
|
89
|
+
...options,
|
|
90
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Press one or more keys on the host computer
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* ```ts
|
|
99
|
+
* await client.browsers.computer.pressKey('id', {
|
|
100
|
+
* keys: ['string'],
|
|
101
|
+
* });
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
pressKey(id: string, body: ComputerPressKeyParams, options?: RequestOptions): APIPromise<void> {
|
|
105
|
+
return this._client.post(path`/browsers/${id}/computer/press_key`, {
|
|
106
|
+
body,
|
|
107
|
+
...options,
|
|
108
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
109
|
+
});
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* Scroll the mouse wheel at a position on the host computer
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```ts
|
|
117
|
+
* await client.browsers.computer.scroll('id', { x: 0, y: 0 });
|
|
118
|
+
* ```
|
|
119
|
+
*/
|
|
120
|
+
scroll(id: string, body: ComputerScrollParams, options?: RequestOptions): APIPromise<void> {
|
|
121
|
+
return this._client.post(path`/browsers/${id}/computer/scroll`, {
|
|
122
|
+
body,
|
|
123
|
+
...options,
|
|
124
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
125
|
+
});
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Type text on the browser instance
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* ```ts
|
|
133
|
+
* await client.browsers.computer.typeText('id', {
|
|
134
|
+
* text: 'text',
|
|
135
|
+
* });
|
|
136
|
+
* ```
|
|
137
|
+
*/
|
|
138
|
+
typeText(id: string, body: ComputerTypeTextParams, options?: RequestOptions): APIPromise<void> {
|
|
139
|
+
return this._client.post(path`/browsers/${id}/computer/type`, {
|
|
140
|
+
body,
|
|
141
|
+
...options,
|
|
142
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
export interface ComputerCaptureScreenshotParams {
|
|
148
|
+
region?: ComputerCaptureScreenshotParams.Region;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
export namespace ComputerCaptureScreenshotParams {
|
|
152
|
+
export interface Region {
|
|
153
|
+
/**
|
|
154
|
+
* Height of the region in pixels
|
|
155
|
+
*/
|
|
156
|
+
height: number;
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* Width of the region in pixels
|
|
160
|
+
*/
|
|
161
|
+
width: number;
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* X coordinate of the region's top-left corner
|
|
165
|
+
*/
|
|
166
|
+
x: number;
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* Y coordinate of the region's top-left corner
|
|
170
|
+
*/
|
|
171
|
+
y: number;
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
export interface ComputerClickMouseParams {
|
|
176
|
+
/**
|
|
177
|
+
* X coordinate of the click position
|
|
178
|
+
*/
|
|
179
|
+
x: number;
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* Y coordinate of the click position
|
|
183
|
+
*/
|
|
184
|
+
y: number;
|
|
185
|
+
|
|
186
|
+
/**
|
|
187
|
+
* Mouse button to interact with
|
|
188
|
+
*/
|
|
189
|
+
button?: 'left' | 'right' | 'middle' | 'back' | 'forward';
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* Type of click action
|
|
193
|
+
*/
|
|
194
|
+
click_type?: 'down' | 'up' | 'click';
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* Modifier keys to hold during the click
|
|
198
|
+
*/
|
|
199
|
+
hold_keys?: Array<string>;
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* Number of times to repeat the click
|
|
203
|
+
*/
|
|
204
|
+
num_clicks?: number;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
export interface ComputerDragMouseParams {
|
|
208
|
+
/**
|
|
209
|
+
* Ordered list of [x, y] coordinate pairs to move through while dragging. Must
|
|
210
|
+
* contain at least 2 points.
|
|
211
|
+
*/
|
|
212
|
+
path: Array<Array<number>>;
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Mouse button to drag with
|
|
216
|
+
*/
|
|
217
|
+
button?: 'left' | 'middle' | 'right';
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* Delay in milliseconds between button down and starting to move along the path.
|
|
221
|
+
*/
|
|
222
|
+
delay?: number;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Modifier keys to hold during the drag
|
|
226
|
+
*/
|
|
227
|
+
hold_keys?: Array<string>;
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Delay in milliseconds between relative steps while dragging (not the initial
|
|
231
|
+
* delay).
|
|
232
|
+
*/
|
|
233
|
+
step_delay_ms?: number;
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
* Number of relative move steps per segment in the path. Minimum 1.
|
|
237
|
+
*/
|
|
238
|
+
steps_per_segment?: number;
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
export interface ComputerMoveMouseParams {
|
|
242
|
+
/**
|
|
243
|
+
* X coordinate to move the cursor to
|
|
244
|
+
*/
|
|
245
|
+
x: number;
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Y coordinate to move the cursor to
|
|
249
|
+
*/
|
|
250
|
+
y: number;
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* Modifier keys to hold during the move
|
|
254
|
+
*/
|
|
255
|
+
hold_keys?: Array<string>;
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
export interface ComputerPressKeyParams {
|
|
259
|
+
/**
|
|
260
|
+
* List of key symbols to press. Each item should be a key symbol supported by
|
|
261
|
+
* xdotool (see X11 keysym definitions). Examples include "Return", "Shift",
|
|
262
|
+
* "Ctrl", "Alt", "F5". Items in this list could also be combinations, e.g.
|
|
263
|
+
* "Ctrl+t" or "Ctrl+Shift+Tab".
|
|
264
|
+
*/
|
|
265
|
+
keys: Array<string>;
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* Duration to hold the keys down in milliseconds. If omitted or 0, keys are
|
|
269
|
+
* tapped.
|
|
270
|
+
*/
|
|
271
|
+
duration?: number;
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Optional modifier keys to hold during the key press sequence.
|
|
275
|
+
*/
|
|
276
|
+
hold_keys?: Array<string>;
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
export interface ComputerScrollParams {
|
|
280
|
+
/**
|
|
281
|
+
* X coordinate at which to perform the scroll
|
|
282
|
+
*/
|
|
283
|
+
x: number;
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* Y coordinate at which to perform the scroll
|
|
287
|
+
*/
|
|
288
|
+
y: number;
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* Horizontal scroll amount. Positive scrolls right, negative scrolls left.
|
|
292
|
+
*/
|
|
293
|
+
delta_x?: number;
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* Vertical scroll amount. Positive scrolls down, negative scrolls up.
|
|
297
|
+
*/
|
|
298
|
+
delta_y?: number;
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* Modifier keys to hold during the scroll
|
|
302
|
+
*/
|
|
303
|
+
hold_keys?: Array<string>;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
export interface ComputerTypeTextParams {
|
|
307
|
+
/**
|
|
308
|
+
* Text to type on the browser instance
|
|
309
|
+
*/
|
|
310
|
+
text: string;
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* Delay in milliseconds between keystrokes
|
|
314
|
+
*/
|
|
315
|
+
delay?: number;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
export declare namespace Computer {
|
|
319
|
+
export {
|
|
320
|
+
type ComputerCaptureScreenshotParams as ComputerCaptureScreenshotParams,
|
|
321
|
+
type ComputerClickMouseParams as ComputerClickMouseParams,
|
|
322
|
+
type ComputerDragMouseParams as ComputerDragMouseParams,
|
|
323
|
+
type ComputerMoveMouseParams as ComputerMoveMouseParams,
|
|
324
|
+
type ComputerPressKeyParams as ComputerPressKeyParams,
|
|
325
|
+
type ComputerScrollParams as ComputerScrollParams,
|
|
326
|
+
type ComputerTypeTextParams as ComputerTypeTextParams,
|
|
327
|
+
};
|
|
328
|
+
}
|