@onkernel/sdk 0.74.0 → 0.75.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 +20 -0
- package/package.json +1 -1
- package/resources/api-keys.d.mts +2 -1
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +2 -1
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/api-keys.js +2 -1
- package/resources/api-keys.js.map +1 -1
- package/resources/api-keys.mjs +2 -1
- package/resources/api-keys.mjs.map +1 -1
- package/resources/apps.d.mts +3 -1
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +3 -1
- package/resources/apps.d.ts.map +1 -1
- package/resources/browser-pools.d.mts +75 -40
- package/resources/browser-pools.d.mts.map +1 -1
- package/resources/browser-pools.d.ts +75 -40
- package/resources/browser-pools.d.ts.map +1 -1
- package/resources/browser-pools.js +3 -1
- package/resources/browser-pools.js.map +1 -1
- package/resources/browser-pools.mjs +3 -1
- package/resources/browser-pools.mjs.map +1 -1
- package/resources/deployments.d.mts +14 -5
- package/resources/deployments.d.mts.map +1 -1
- package/resources/deployments.d.ts +14 -5
- package/resources/deployments.d.ts.map +1 -1
- package/resources/extensions.d.mts +24 -0
- package/resources/extensions.d.mts.map +1 -1
- package/resources/extensions.d.ts +24 -0
- package/resources/extensions.d.ts.map +1 -1
- package/src/resources/api-keys.ts +2 -1
- package/src/resources/apps.ts +3 -1
- package/src/resources/browser-pools.ts +80 -40
- package/src/resources/deployments.ts +14 -5
- package/src/resources/extensions.ts +27 -0
- 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
|
@@ -48,7 +48,9 @@ export class BrowserPools extends APIResource {
|
|
|
48
48
|
/**
|
|
49
49
|
* Updates the configuration used to create browsers in the pool. As with creation,
|
|
50
50
|
* save_changes on the pool profile is ignored (not rejected); pooled browsers
|
|
51
|
-
* never persist changes back to the profile.
|
|
51
|
+
* never persist changes back to the profile. To clear the profile reference, send
|
|
52
|
+
* `profile: { "id": "" }`. Clearing the profile also disables
|
|
53
|
+
* `refresh_on_profile_update`.
|
|
52
54
|
*
|
|
53
55
|
* @example
|
|
54
56
|
* ```ts
|
|
@@ -186,10 +188,26 @@ export interface BrowserPool {
|
|
|
186
188
|
*/
|
|
187
189
|
created_at: string;
|
|
188
190
|
|
|
191
|
+
/**
|
|
192
|
+
* Resolved extension IDs attached to the pool, in configured load order. Empty
|
|
193
|
+
* when no extensions are attached. Authoritative for programmatic consumers; the
|
|
194
|
+
* extensions inside `browser_pool_config` reflect the configured selector (echoed
|
|
195
|
+
* as sent on create).
|
|
196
|
+
*/
|
|
197
|
+
extension_ids: Array<string>;
|
|
198
|
+
|
|
189
199
|
/**
|
|
190
200
|
* Browser pool name, if set
|
|
191
201
|
*/
|
|
192
202
|
name?: string;
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Resolved profile ID the pool is attached to. Omitted when no profile is
|
|
206
|
+
* attached. Authoritative for programmatic consumers; the profile inside
|
|
207
|
+
* `browser_pool_config` reflects the configured selector (echoed as sent on
|
|
208
|
+
* create).
|
|
209
|
+
*/
|
|
210
|
+
profile_id?: string;
|
|
193
211
|
}
|
|
194
212
|
|
|
195
213
|
export namespace BrowserPool {
|
|
@@ -241,12 +259,11 @@ export namespace BrowserPool {
|
|
|
241
259
|
name?: string;
|
|
242
260
|
|
|
243
261
|
/**
|
|
244
|
-
* Profile
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
249
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
262
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
263
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
264
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
265
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
266
|
+
* rather than rejected.
|
|
250
267
|
*/
|
|
251
268
|
profile?: BrowserPoolConfig.Profile;
|
|
252
269
|
|
|
@@ -256,6 +273,13 @@ export namespace BrowserPool {
|
|
|
256
273
|
*/
|
|
257
274
|
proxy_id?: string;
|
|
258
275
|
|
|
276
|
+
/**
|
|
277
|
+
* When true, flush idle browsers when the profile the pool uses is updated, so
|
|
278
|
+
* pool browsers pick up the latest profile data. Requires a profile to be set on
|
|
279
|
+
* the pool.
|
|
280
|
+
*/
|
|
281
|
+
refresh_on_profile_update?: boolean;
|
|
282
|
+
|
|
259
283
|
/**
|
|
260
284
|
* Optional URL to navigate to when a new browser is warmed into the pool.
|
|
261
285
|
* Best-effort: failures to navigate do not fail pool fill. Only applied to
|
|
@@ -296,12 +320,11 @@ export namespace BrowserPool {
|
|
|
296
320
|
|
|
297
321
|
export namespace BrowserPoolConfig {
|
|
298
322
|
/**
|
|
299
|
-
* Profile
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
*
|
|
303
|
-
*
|
|
304
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
323
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
324
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
325
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
326
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
327
|
+
* rather than rejected.
|
|
305
328
|
*/
|
|
306
329
|
export interface Profile {
|
|
307
330
|
/**
|
|
@@ -495,12 +518,11 @@ export interface BrowserPoolCreateParams {
|
|
|
495
518
|
name?: string;
|
|
496
519
|
|
|
497
520
|
/**
|
|
498
|
-
* Profile
|
|
499
|
-
*
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
*
|
|
503
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
521
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
522
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
523
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
524
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
525
|
+
* rather than rejected.
|
|
504
526
|
*/
|
|
505
527
|
profile?: BrowserPoolCreateParams.Profile;
|
|
506
528
|
|
|
@@ -510,6 +532,13 @@ export interface BrowserPoolCreateParams {
|
|
|
510
532
|
*/
|
|
511
533
|
proxy_id?: string;
|
|
512
534
|
|
|
535
|
+
/**
|
|
536
|
+
* When true, flush idle browsers when the profile the pool uses is updated, so
|
|
537
|
+
* pool browsers pick up the latest profile data. Requires a profile to be set on
|
|
538
|
+
* the pool.
|
|
539
|
+
*/
|
|
540
|
+
refresh_on_profile_update?: boolean;
|
|
541
|
+
|
|
513
542
|
/**
|
|
514
543
|
* Optional URL to navigate to when a new browser is warmed into the pool.
|
|
515
544
|
* Best-effort: failures to navigate do not fail pool fill. Only applied to
|
|
@@ -550,12 +579,11 @@ export interface BrowserPoolCreateParams {
|
|
|
550
579
|
|
|
551
580
|
export namespace BrowserPoolCreateParams {
|
|
552
581
|
/**
|
|
553
|
-
* Profile
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
*
|
|
558
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
582
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
583
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
584
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
585
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
586
|
+
* rather than rejected.
|
|
559
587
|
*/
|
|
560
588
|
export interface Profile {
|
|
561
589
|
/**
|
|
@@ -581,8 +609,12 @@ export interface BrowserPoolUpdateParams {
|
|
|
581
609
|
chrome_policy?: { [key: string]: unknown };
|
|
582
610
|
|
|
583
611
|
/**
|
|
584
|
-
* Whether to discard all idle browsers and rebuild
|
|
585
|
-
* to false.
|
|
612
|
+
* Whether to discard all idle browsers and rebuild them immediately with the new
|
|
613
|
+
* configuration. Defaults to false. Only browsers that are idle when the update
|
|
614
|
+
* runs are rebuilt. A browser that is in use during the update keeps its original
|
|
615
|
+
* configuration, and if it is later released with `reuse: true` it returns to the
|
|
616
|
+
* pool with that stale configuration until it is discarded (by this flag on a
|
|
617
|
+
* later update, or by flushing the pool).
|
|
586
618
|
*/
|
|
587
619
|
discard_all_idle?: boolean;
|
|
588
620
|
|
|
@@ -615,12 +647,11 @@ export interface BrowserPoolUpdateParams {
|
|
|
615
647
|
name?: string;
|
|
616
648
|
|
|
617
649
|
/**
|
|
618
|
-
* Profile
|
|
619
|
-
*
|
|
620
|
-
*
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
650
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
651
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
652
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
653
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
654
|
+
* rather than rejected.
|
|
624
655
|
*/
|
|
625
656
|
profile?: BrowserPoolUpdateParams.Profile;
|
|
626
657
|
|
|
@@ -630,6 +661,13 @@ export interface BrowserPoolUpdateParams {
|
|
|
630
661
|
*/
|
|
631
662
|
proxy_id?: string;
|
|
632
663
|
|
|
664
|
+
/**
|
|
665
|
+
* When true, flush idle browsers when the profile the pool uses is updated, so
|
|
666
|
+
* pool browsers pick up the latest profile data. Requires a profile to be set on
|
|
667
|
+
* the pool.
|
|
668
|
+
*/
|
|
669
|
+
refresh_on_profile_update?: boolean;
|
|
670
|
+
|
|
633
671
|
/**
|
|
634
672
|
* Number of browsers to maintain in the pool. The maximum size is determined by
|
|
635
673
|
* your organization's pooled sessions limit (the sum of all pool sizes cannot
|
|
@@ -677,12 +715,11 @@ export interface BrowserPoolUpdateParams {
|
|
|
677
715
|
|
|
678
716
|
export namespace BrowserPoolUpdateParams {
|
|
679
717
|
/**
|
|
680
|
-
* Profile
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
*
|
|
685
|
-
* rejected, so callers reusing a single-session profile object will not error.
|
|
718
|
+
* Profile configuration for browsers in a pool. Provide either id or name.
|
|
719
|
+
* Profiles must be created beforehand. Unlike single browser sessions, pools load
|
|
720
|
+
* the profile read-only and never persist changes back to it, so save_changes is
|
|
721
|
+
* omitted here. Any save_changes value sent on a pool profile is silently ignored
|
|
722
|
+
* rather than rejected.
|
|
686
723
|
*/
|
|
687
724
|
export interface Profile {
|
|
688
725
|
/**
|
|
@@ -752,7 +789,10 @@ export interface BrowserPoolReleaseParams {
|
|
|
752
789
|
|
|
753
790
|
/**
|
|
754
791
|
* Whether to reuse the browser instance or destroy it and create a new one.
|
|
755
|
-
* Defaults to true.
|
|
792
|
+
* Defaults to true. A reused browser keeps the configuration it was created with,
|
|
793
|
+
* so it does not pick up pool configuration changes made while it was in use.
|
|
794
|
+
* Release with `reuse: false`, or flush the pool afterward, to rebuild it with the
|
|
795
|
+
* current configuration.
|
|
756
796
|
*/
|
|
757
797
|
reuse?: boolean;
|
|
758
798
|
}
|
|
@@ -159,7 +159,9 @@ export namespace DeploymentStateEvent {
|
|
|
159
159
|
entrypoint_rel_path?: string;
|
|
160
160
|
|
|
161
161
|
/**
|
|
162
|
-
* Environment variables configured for this deployment
|
|
162
|
+
* Environment variables configured for this deployment. Values are redacted for
|
|
163
|
+
* API key, OAuth, and managed-auth callers, which receive every key with an empty
|
|
164
|
+
* string value. Only dashboard sessions receive the actual values.
|
|
163
165
|
*/
|
|
164
166
|
env_vars?: { [key: string]: string };
|
|
165
167
|
|
|
@@ -205,7 +207,9 @@ export interface DeploymentCreateResponse {
|
|
|
205
207
|
entrypoint_rel_path?: string;
|
|
206
208
|
|
|
207
209
|
/**
|
|
208
|
-
* Environment variables configured for this deployment
|
|
210
|
+
* Environment variables configured for this deployment. Values are redacted for
|
|
211
|
+
* API key, OAuth, and managed-auth callers, which receive every key with an empty
|
|
212
|
+
* string value. Only dashboard sessions receive the actual values.
|
|
209
213
|
*/
|
|
210
214
|
env_vars?: { [key: string]: string };
|
|
211
215
|
|
|
@@ -250,7 +254,9 @@ export interface DeploymentRetrieveResponse {
|
|
|
250
254
|
entrypoint_rel_path?: string;
|
|
251
255
|
|
|
252
256
|
/**
|
|
253
|
-
* Environment variables configured for this deployment
|
|
257
|
+
* Environment variables configured for this deployment. Values are redacted for
|
|
258
|
+
* API key, OAuth, and managed-auth callers, which receive every key with an empty
|
|
259
|
+
* string value. Only dashboard sessions receive the actual values.
|
|
254
260
|
*/
|
|
255
261
|
env_vars?: { [key: string]: string };
|
|
256
262
|
|
|
@@ -295,7 +301,9 @@ export interface DeploymentListResponse {
|
|
|
295
301
|
entrypoint_rel_path?: string;
|
|
296
302
|
|
|
297
303
|
/**
|
|
298
|
-
* Environment variables configured for this deployment
|
|
304
|
+
* Environment variables configured for this deployment. Values are redacted for
|
|
305
|
+
* API key, OAuth, and managed-auth callers, which receive every key with an empty
|
|
306
|
+
* string value. Only dashboard sessions receive the actual values.
|
|
299
307
|
*/
|
|
300
308
|
env_vars?: { [key: string]: string };
|
|
301
309
|
|
|
@@ -361,7 +369,8 @@ export namespace DeploymentFollowResponse {
|
|
|
361
369
|
version: string;
|
|
362
370
|
|
|
363
371
|
/**
|
|
364
|
-
* Environment variables configured for this app version
|
|
372
|
+
* Environment variables configured for this app version. Not currently populated
|
|
373
|
+
* on streamed app_version_summary events.
|
|
365
374
|
*/
|
|
366
375
|
env_vars?: { [key: string]: string };
|
|
367
376
|
}
|
|
@@ -147,6 +147,15 @@ export interface ExtensionListResponse {
|
|
|
147
147
|
*/
|
|
148
148
|
size_bytes: number;
|
|
149
149
|
|
|
150
|
+
/**
|
|
151
|
+
* SHA-256 checksum, encoded as lowercase hexadecimal, of the exact uploaded
|
|
152
|
+
* extension archive bytes. This is not a normalized checksum of the extension
|
|
153
|
+
* contents; archive metadata, file ordering, and compression can change the
|
|
154
|
+
* checksum for otherwise identical contents. Omitted for legacy rows and
|
|
155
|
+
* server-repackaged Chrome Web Store extensions.
|
|
156
|
+
*/
|
|
157
|
+
checksum?: string | null;
|
|
158
|
+
|
|
150
159
|
/**
|
|
151
160
|
* Timestamp when the extension was last used
|
|
152
161
|
*/
|
|
@@ -178,6 +187,15 @@ export interface ExtensionGetResponse {
|
|
|
178
187
|
*/
|
|
179
188
|
size_bytes: number;
|
|
180
189
|
|
|
190
|
+
/**
|
|
191
|
+
* SHA-256 checksum, encoded as lowercase hexadecimal, of the exact uploaded
|
|
192
|
+
* extension archive bytes. This is not a normalized checksum of the extension
|
|
193
|
+
* contents; archive metadata, file ordering, and compression can change the
|
|
194
|
+
* checksum for otherwise identical contents. Omitted for legacy rows and
|
|
195
|
+
* server-repackaged Chrome Web Store extensions.
|
|
196
|
+
*/
|
|
197
|
+
checksum?: string | null;
|
|
198
|
+
|
|
181
199
|
/**
|
|
182
200
|
* Timestamp when the extension was last used
|
|
183
201
|
*/
|
|
@@ -209,6 +227,15 @@ export interface ExtensionUploadResponse {
|
|
|
209
227
|
*/
|
|
210
228
|
size_bytes: number;
|
|
211
229
|
|
|
230
|
+
/**
|
|
231
|
+
* SHA-256 checksum, encoded as lowercase hexadecimal, of the exact uploaded
|
|
232
|
+
* extension archive bytes. This is not a normalized checksum of the extension
|
|
233
|
+
* contents; archive metadata, file ordering, and compression can change the
|
|
234
|
+
* checksum for otherwise identical contents. Omitted for legacy rows and
|
|
235
|
+
* server-repackaged Chrome Web Store extensions.
|
|
236
|
+
*/
|
|
237
|
+
checksum?: string | null;
|
|
238
|
+
|
|
212
239
|
/**
|
|
213
240
|
* Timestamp when the extension was last used
|
|
214
241
|
*/
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.
|
|
1
|
+
export const VERSION = '0.75.0'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.75.0";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.75.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '0.
|
|
1
|
+
export const VERSION = '0.75.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|