@onkernel/sdk 0.14.0 → 0.14.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.
@@ -143,7 +143,7 @@ export class Browsers extends APIResource {
143
143
  *
144
144
  * @example
145
145
  * ```ts
146
- * await client.browsers.uploadExtensions('id', {
146
+ * await client.browsers.loadExtensions('id', {
147
147
  * extensions: [
148
148
  * {
149
149
  * name: 'name',
@@ -153,11 +153,7 @@ export class Browsers extends APIResource {
153
153
  * });
154
154
  * ```
155
155
  */
156
- uploadExtensions(
157
- id: string,
158
- body: BrowserUploadExtensionsParams,
159
- options?: RequestOptions,
160
- ): APIPromise<void> {
156
+ loadExtensions(id: string, body: BrowserLoadExtensionsParams, options?: RequestOptions): APIPromise<void> {
161
157
  return this._client.post(
162
158
  path`/browsers/${id}/extensions`,
163
159
  multipartFormRequestOptions(
@@ -259,6 +255,48 @@ export interface BrowserCreateResponse {
259
255
  * ID of the proxy associated with this browser session, if any.
260
256
  */
261
257
  proxy_id?: string;
258
+
259
+ /**
260
+ * Initial browser window size in pixels with optional refresh rate. If omitted,
261
+ * image defaults apply (commonly 1024x768@60). Only specific viewport
262
+ * configurations are supported. The server will reject unsupported combinations.
263
+ * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
264
+ * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
265
+ * automatically determined from the width and height if they match a supported
266
+ * configuration exactly. Note: Higher resolutions may affect the responsiveness of
267
+ * live view browser
268
+ */
269
+ viewport?: BrowserCreateResponse.Viewport;
270
+ }
271
+
272
+ export namespace BrowserCreateResponse {
273
+ /**
274
+ * Initial browser window size in pixels with optional refresh rate. If omitted,
275
+ * image defaults apply (commonly 1024x768@60). Only specific viewport
276
+ * configurations are supported. The server will reject unsupported combinations.
277
+ * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
278
+ * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
279
+ * automatically determined from the width and height if they match a supported
280
+ * configuration exactly. Note: Higher resolutions may affect the responsiveness of
281
+ * live view browser
282
+ */
283
+ export interface Viewport {
284
+ /**
285
+ * Browser window height in pixels.
286
+ */
287
+ height: number;
288
+
289
+ /**
290
+ * Browser window width in pixels.
291
+ */
292
+ width: number;
293
+
294
+ /**
295
+ * Display refresh rate in Hz. If omitted, automatically determined from width and
296
+ * height.
297
+ */
298
+ refresh_rate?: number;
299
+ }
262
300
  }
263
301
 
264
302
  export interface BrowserRetrieveResponse {
@@ -312,6 +350,48 @@ export interface BrowserRetrieveResponse {
312
350
  * ID of the proxy associated with this browser session, if any.
313
351
  */
314
352
  proxy_id?: string;
353
+
354
+ /**
355
+ * Initial browser window size in pixels with optional refresh rate. If omitted,
356
+ * image defaults apply (commonly 1024x768@60). Only specific viewport
357
+ * configurations are supported. The server will reject unsupported combinations.
358
+ * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
359
+ * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
360
+ * automatically determined from the width and height if they match a supported
361
+ * configuration exactly. Note: Higher resolutions may affect the responsiveness of
362
+ * live view browser
363
+ */
364
+ viewport?: BrowserRetrieveResponse.Viewport;
365
+ }
366
+
367
+ export namespace BrowserRetrieveResponse {
368
+ /**
369
+ * Initial browser window size in pixels with optional refresh rate. If omitted,
370
+ * image defaults apply (commonly 1024x768@60). Only specific viewport
371
+ * configurations are supported. The server will reject unsupported combinations.
372
+ * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
373
+ * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
374
+ * automatically determined from the width and height if they match a supported
375
+ * configuration exactly. Note: Higher resolutions may affect the responsiveness of
376
+ * live view browser
377
+ */
378
+ export interface Viewport {
379
+ /**
380
+ * Browser window height in pixels.
381
+ */
382
+ height: number;
383
+
384
+ /**
385
+ * Browser window width in pixels.
386
+ */
387
+ width: number;
388
+
389
+ /**
390
+ * Display refresh rate in Hz. If omitted, automatically determined from width and
391
+ * height.
392
+ */
393
+ refresh_rate?: number;
394
+ }
315
395
  }
316
396
 
317
397
  export type BrowserListResponse = Array<BrowserListResponse.BrowserListResponseItem>;
@@ -368,6 +448,48 @@ export namespace BrowserListResponse {
368
448
  * ID of the proxy associated with this browser session, if any.
369
449
  */
370
450
  proxy_id?: string;
451
+
452
+ /**
453
+ * Initial browser window size in pixels with optional refresh rate. If omitted,
454
+ * image defaults apply (commonly 1024x768@60). Only specific viewport
455
+ * configurations are supported. The server will reject unsupported combinations.
456
+ * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
457
+ * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
458
+ * automatically determined from the width and height if they match a supported
459
+ * configuration exactly. Note: Higher resolutions may affect the responsiveness of
460
+ * live view browser
461
+ */
462
+ viewport?: BrowserListResponseItem.Viewport;
463
+ }
464
+
465
+ export namespace BrowserListResponseItem {
466
+ /**
467
+ * Initial browser window size in pixels with optional refresh rate. If omitted,
468
+ * image defaults apply (commonly 1024x768@60). Only specific viewport
469
+ * configurations are supported. The server will reject unsupported combinations.
470
+ * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
471
+ * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
472
+ * automatically determined from the width and height if they match a supported
473
+ * configuration exactly. Note: Higher resolutions may affect the responsiveness of
474
+ * live view browser
475
+ */
476
+ export interface Viewport {
477
+ /**
478
+ * Browser window height in pixels.
479
+ */
480
+ height: number;
481
+
482
+ /**
483
+ * Browser window width in pixels.
484
+ */
485
+ width: number;
486
+
487
+ /**
488
+ * Display refresh rate in Hz. If omitted, automatically determined from width and
489
+ * height.
490
+ */
491
+ refresh_rate?: number;
492
+ }
371
493
  }
372
494
  }
373
495
 
@@ -421,6 +543,18 @@ export interface BrowserCreateParams {
421
543
  * specified value.
422
544
  */
423
545
  timeout_seconds?: number;
546
+
547
+ /**
548
+ * Initial browser window size in pixels with optional refresh rate. If omitted,
549
+ * image defaults apply (commonly 1024x768@60). Only specific viewport
550
+ * configurations are supported. The server will reject unsupported combinations.
551
+ * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
552
+ * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
553
+ * automatically determined from the width and height if they match a supported
554
+ * configuration exactly. Note: Higher resolutions may affect the responsiveness of
555
+ * live view browser
556
+ */
557
+ viewport?: BrowserCreateParams.Viewport;
424
558
  }
425
559
 
426
560
  export namespace BrowserCreateParams {
@@ -464,6 +598,34 @@ export namespace BrowserCreateParams {
464
598
  */
465
599
  save_changes?: boolean;
466
600
  }
601
+
602
+ /**
603
+ * Initial browser window size in pixels with optional refresh rate. If omitted,
604
+ * image defaults apply (commonly 1024x768@60). Only specific viewport
605
+ * configurations are supported. The server will reject unsupported combinations.
606
+ * Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25,
607
+ * 1440x900@25, 1024x768@60 If refresh_rate is not provided, it will be
608
+ * automatically determined from the width and height if they match a supported
609
+ * configuration exactly. Note: Higher resolutions may affect the responsiveness of
610
+ * live view browser
611
+ */
612
+ export interface Viewport {
613
+ /**
614
+ * Browser window height in pixels.
615
+ */
616
+ height: number;
617
+
618
+ /**
619
+ * Browser window width in pixels.
620
+ */
621
+ width: number;
622
+
623
+ /**
624
+ * Display refresh rate in Hz. If omitted, automatically determined from width and
625
+ * height.
626
+ */
627
+ refresh_rate?: number;
628
+ }
467
629
  }
468
630
 
469
631
  export interface BrowserDeleteParams {
@@ -473,14 +635,14 @@ export interface BrowserDeleteParams {
473
635
  persistent_id: string;
474
636
  }
475
637
 
476
- export interface BrowserUploadExtensionsParams {
638
+ export interface BrowserLoadExtensionsParams {
477
639
  /**
478
640
  * List of extensions to upload and activate
479
641
  */
480
- extensions: Array<BrowserUploadExtensionsParams.Extension>;
642
+ extensions: Array<BrowserLoadExtensionsParams.Extension>;
481
643
  }
482
644
 
483
- export namespace BrowserUploadExtensionsParams {
645
+ export namespace BrowserLoadExtensionsParams {
484
646
  export interface Extension {
485
647
  /**
486
648
  * Folder name to place the extension under /home/kernel/extensions/<name>
@@ -509,7 +671,7 @@ export declare namespace Browsers {
509
671
  type BrowserListResponse as BrowserListResponse,
510
672
  type BrowserCreateParams as BrowserCreateParams,
511
673
  type BrowserDeleteParams as BrowserDeleteParams,
512
- type BrowserUploadExtensionsParams as BrowserUploadExtensionsParams,
674
+ type BrowserLoadExtensionsParams as BrowserLoadExtensionsParams,
513
675
  };
514
676
 
515
677
  export {
@@ -9,7 +9,7 @@ export {
9
9
  type BrowserListResponse,
10
10
  type BrowserCreateParams,
11
11
  type BrowserDeleteParams,
12
- type BrowserUploadExtensionsParams,
12
+ type BrowserLoadExtensionsParams,
13
13
  } from './browsers';
14
14
  export {
15
15
  Fs,
@@ -11,7 +11,7 @@ export {
11
11
  type BrowserListResponse,
12
12
  type BrowserCreateParams,
13
13
  type BrowserDeleteParams,
14
- type BrowserUploadExtensionsParams,
14
+ type BrowserLoadExtensionsParams,
15
15
  } from './browsers/browsers';
16
16
  export {
17
17
  Deployments,
@@ -88,7 +88,7 @@ export namespace ProxyCreateResponse {
88
88
  */
89
89
  export interface DatacenterProxyConfig {
90
90
  /**
91
- * ISO 3166 country code or EU for the proxy exit node.
91
+ * ISO 3166 country code.
92
92
  */
93
93
  country: string;
94
94
  }
@@ -98,7 +98,7 @@ export namespace ProxyCreateResponse {
98
98
  */
99
99
  export interface IspProxyConfig {
100
100
  /**
101
- * ISO 3166 country code or EU for the proxy exit node.
101
+ * ISO 3166 country code.
102
102
  */
103
103
  country: string;
104
104
  }
@@ -119,13 +119,12 @@ export namespace ProxyCreateResponse {
119
119
  city?: string;
120
120
 
121
121
  /**
122
- * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
123
- * provided.
122
+ * ISO 3166 country code.
124
123
  */
125
124
  country?: string;
126
125
 
127
126
  /**
128
- * Operating system of the residential device.
127
+ * @deprecated Operating system of the residential device.
129
128
  */
130
129
  os?: 'windows' | 'macos' | 'android';
131
130
 
@@ -219,8 +218,7 @@ export namespace ProxyCreateResponse {
219
218
  city?: string;
220
219
 
221
220
  /**
222
- * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
223
- * provided.
221
+ * ISO 3166 country code
224
222
  */
225
223
  country?: string;
226
224
 
@@ -310,7 +308,7 @@ export namespace ProxyRetrieveResponse {
310
308
  */
311
309
  export interface DatacenterProxyConfig {
312
310
  /**
313
- * ISO 3166 country code or EU for the proxy exit node.
311
+ * ISO 3166 country code.
314
312
  */
315
313
  country: string;
316
314
  }
@@ -320,7 +318,7 @@ export namespace ProxyRetrieveResponse {
320
318
  */
321
319
  export interface IspProxyConfig {
322
320
  /**
323
- * ISO 3166 country code or EU for the proxy exit node.
321
+ * ISO 3166 country code.
324
322
  */
325
323
  country: string;
326
324
  }
@@ -341,13 +339,12 @@ export namespace ProxyRetrieveResponse {
341
339
  city?: string;
342
340
 
343
341
  /**
344
- * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
345
- * provided.
342
+ * ISO 3166 country code.
346
343
  */
347
344
  country?: string;
348
345
 
349
346
  /**
350
- * Operating system of the residential device.
347
+ * @deprecated Operating system of the residential device.
351
348
  */
352
349
  os?: 'windows' | 'macos' | 'android';
353
350
 
@@ -441,8 +438,7 @@ export namespace ProxyRetrieveResponse {
441
438
  city?: string;
442
439
 
443
440
  /**
444
- * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
445
- * provided.
441
+ * ISO 3166 country code
446
442
  */
447
443
  country?: string;
448
444
 
@@ -535,7 +531,7 @@ export namespace ProxyListResponse {
535
531
  */
536
532
  export interface DatacenterProxyConfig {
537
533
  /**
538
- * ISO 3166 country code or EU for the proxy exit node.
534
+ * ISO 3166 country code.
539
535
  */
540
536
  country: string;
541
537
  }
@@ -545,7 +541,7 @@ export namespace ProxyListResponse {
545
541
  */
546
542
  export interface IspProxyConfig {
547
543
  /**
548
- * ISO 3166 country code or EU for the proxy exit node.
544
+ * ISO 3166 country code.
549
545
  */
550
546
  country: string;
551
547
  }
@@ -566,13 +562,12 @@ export namespace ProxyListResponse {
566
562
  city?: string;
567
563
 
568
564
  /**
569
- * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
570
- * provided.
565
+ * ISO 3166 country code.
571
566
  */
572
567
  country?: string;
573
568
 
574
569
  /**
575
- * Operating system of the residential device.
570
+ * @deprecated Operating system of the residential device.
576
571
  */
577
572
  os?: 'windows' | 'macos' | 'android';
578
573
 
@@ -666,8 +661,7 @@ export namespace ProxyListResponse {
666
661
  city?: string;
667
662
 
668
663
  /**
669
- * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
670
- * provided.
664
+ * ISO 3166 country code
671
665
  */
672
666
  country?: string;
673
667
 
@@ -743,7 +737,7 @@ export namespace ProxyCreateParams {
743
737
  */
744
738
  export interface DatacenterProxyConfig {
745
739
  /**
746
- * ISO 3166 country code or EU for the proxy exit node.
740
+ * ISO 3166 country code.
747
741
  */
748
742
  country: string;
749
743
  }
@@ -753,7 +747,7 @@ export namespace ProxyCreateParams {
753
747
  */
754
748
  export interface IspProxyConfig {
755
749
  /**
756
- * ISO 3166 country code or EU for the proxy exit node.
750
+ * ISO 3166 country code.
757
751
  */
758
752
  country: string;
759
753
  }
@@ -774,13 +768,12 @@ export namespace ProxyCreateParams {
774
768
  city?: string;
775
769
 
776
770
  /**
777
- * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
778
- * provided.
771
+ * ISO 3166 country code.
779
772
  */
780
773
  country?: string;
781
774
 
782
775
  /**
783
- * Operating system of the residential device.
776
+ * @deprecated Operating system of the residential device.
784
777
  */
785
778
  os?: 'windows' | 'macos' | 'android';
786
779
 
@@ -874,8 +867,7 @@ export namespace ProxyCreateParams {
874
867
  city?: string;
875
868
 
876
869
  /**
877
- * ISO 3166 country code or EU for the proxy exit node. Required if `city` is
878
- * provided.
870
+ * ISO 3166 country code
879
871
  */
880
872
  country?: string;
881
873
 
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.14.0'; // x-release-please-version
1
+ export const VERSION = '0.14.1'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.14.0";
1
+ export declare const VERSION = "0.14.1";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.14.0";
1
+ export declare const VERSION = "0.14.1";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.14.0'; // x-release-please-version
4
+ exports.VERSION = '0.14.1'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.14.0'; // x-release-please-version
1
+ export const VERSION = '0.14.1'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map