@onkernel/sdk 0.78.1 → 0.80.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.
@@ -352,6 +352,12 @@ export interface ManagedAuth {
352
352
  | 'requires_sms_code'
353
353
  | 'requires_email_code';
354
354
 
355
+ /**
356
+ * Canonical choices awaiting selection. Prefer this over pending_sso_buttons,
357
+ * mfa_options, and sign_in_options when present.
358
+ */
359
+ choices?: Array<ManagedAuth.Choice> | null;
360
+
355
361
  /**
356
362
  * Reference to credentials for the auth connection. Use one of:
357
363
  *
@@ -383,6 +389,12 @@ export interface ManagedAuth {
383
389
  */
384
390
  external_action_message?: string | null;
385
391
 
392
+ /**
393
+ * Canonical fields awaiting input. Prefer this over discovered_fields when
394
+ * present.
395
+ */
396
+ fields?: Array<ManagedAuth.Field> | null;
397
+
386
398
  /**
387
399
  * When the current flow expires (null when no flow in progress). A flow past this
388
400
  * timestamp is no longer valid and its `flow_status` will be `EXPIRED`. Clients
@@ -503,6 +515,43 @@ export interface ManagedAuth {
503
515
  }
504
516
 
505
517
  export namespace ManagedAuth {
518
+ /**
519
+ * Canonical auth-flow choice awaiting user selection.
520
+ */
521
+ export interface Choice {
522
+ /**
523
+ * Stable choice identifier for canonical submit.
524
+ */
525
+ id: string;
526
+
527
+ /**
528
+ * Human-readable choice label.
529
+ */
530
+ label: string;
531
+
532
+ /**
533
+ * Choice type.
534
+ */
535
+ type:
536
+ | 'mfa_method'
537
+ | 'sso_provider'
538
+ | 'sign_in_method'
539
+ | 'auth_method'
540
+ | 'identifier_method'
541
+ | 'account'
542
+ | 'other';
543
+
544
+ /**
545
+ * Additional context for the choice.
546
+ */
547
+ description?: string | null;
548
+
549
+ /**
550
+ * Selector for the visible choice, when available.
551
+ */
552
+ observed_selector?: string | null;
553
+ }
554
+
506
555
  /**
507
556
  * Reference to credentials for the auth connection. Use one of:
508
557
  *
@@ -579,6 +628,41 @@ export namespace ManagedAuth {
579
628
  required?: boolean;
580
629
  }
581
630
 
631
+ /**
632
+ * Canonical field awaiting user input.
633
+ */
634
+ export interface Field {
635
+ /**
636
+ * Stable field identifier for canonical submit.
637
+ */
638
+ id: string;
639
+
640
+ /**
641
+ * Credential reference name to store the submitted value under.
642
+ */
643
+ ref: string;
644
+
645
+ /**
646
+ * Managed-auth field type.
647
+ */
648
+ type: 'identifier' | 'password' | 'code' | 'totp_code' | 'totp_secret' | 'text';
649
+
650
+ /**
651
+ * Human-readable label shown to the user.
652
+ */
653
+ label?: string;
654
+
655
+ /**
656
+ * Selector for the visible field, when available.
657
+ */
658
+ observed_selector?: string | null;
659
+
660
+ /**
661
+ * Whether this field is required.
662
+ */
663
+ required?: boolean;
664
+ }
665
+
582
666
  /**
583
667
  * An MFA method option for verification
584
668
  */
@@ -825,6 +909,11 @@ export interface ManagedAuthTimelineEvent {
825
909
  */
826
910
  type: 'login' | 'reauth' | 'health_check';
827
911
 
912
+ /**
913
+ * Browser session that produced the event, if one was created.
914
+ */
915
+ browser_session_id?: string;
916
+
828
917
  /**
829
918
  * Machine-readable error code. Present when a login/reauth event failed.
830
919
  */
@@ -989,10 +1078,17 @@ export namespace ManagedAuthUpdateRequest {
989
1078
 
990
1079
  /**
991
1080
  * Request to submit field values, click an SSO button, select an MFA method, or
992
- * select a sign-in option. Provide exactly one of fields, sso_button_selector,
993
- * sso_provider, mfa_option_id, or sign_in_option_id.
1081
+ * select a sign-in option. Prefer canonical selected_choice_id/field_values when
1082
+ * the API returns fields/choices; legacy
1083
+ * fields/sso_button_selector/sso_provider/mfa_option_id/sign_in_option_id remain
1084
+ * supported during deprecation.
994
1085
  */
995
1086
  export interface SubmitFieldsRequest {
1087
+ /**
1088
+ * Canonical map of field ID to submitted value.
1089
+ */
1090
+ field_values?: { [key: string]: string };
1091
+
996
1092
  /**
997
1093
  * Map of field name to value
998
1094
  */
@@ -1003,6 +1099,11 @@ export interface SubmitFieldsRequest {
1003
1099
  */
1004
1100
  mfa_option_id?: string;
1005
1101
 
1102
+ /**
1103
+ * Canonical choice ID selected by the user.
1104
+ */
1105
+ selected_choice_id?: string;
1106
+
1006
1107
  /**
1007
1108
  * The sign-in option ID to select (when sign_in_options were returned)
1008
1109
  */
@@ -1064,6 +1165,12 @@ export namespace ConnectionFollowResponse {
1064
1165
  */
1065
1166
  timestamp: string;
1066
1167
 
1168
+ /**
1169
+ * Canonical choices awaiting selection. Prefer this over pending_sso_buttons,
1170
+ * mfa_options, and sign_in_options when present.
1171
+ */
1172
+ choices?: Array<ManagedAuthStateEvent.Choice>;
1173
+
1067
1174
  /**
1068
1175
  * Fields awaiting input (present when flow_step=AWAITING_INPUT; may also be
1069
1176
  * present with AWAITING_EXTERNAL_ACTION as fallback actions).
@@ -1086,6 +1193,12 @@ export namespace ConnectionFollowResponse {
1086
1193
  */
1087
1194
  external_action_message?: string;
1088
1195
 
1196
+ /**
1197
+ * Canonical fields awaiting input. Prefer this over discovered_fields when
1198
+ * present.
1199
+ */
1200
+ fields?: Array<ManagedAuthStateEvent.Field>;
1201
+
1089
1202
  /**
1090
1203
  * Type of the current flow.
1091
1204
  */
@@ -1133,6 +1246,43 @@ export namespace ConnectionFollowResponse {
1133
1246
  }
1134
1247
 
1135
1248
  export namespace ManagedAuthStateEvent {
1249
+ /**
1250
+ * Canonical auth-flow choice awaiting user selection.
1251
+ */
1252
+ export interface Choice {
1253
+ /**
1254
+ * Stable choice identifier for canonical submit.
1255
+ */
1256
+ id: string;
1257
+
1258
+ /**
1259
+ * Human-readable choice label.
1260
+ */
1261
+ label: string;
1262
+
1263
+ /**
1264
+ * Choice type.
1265
+ */
1266
+ type:
1267
+ | 'mfa_method'
1268
+ | 'sso_provider'
1269
+ | 'sign_in_method'
1270
+ | 'auth_method'
1271
+ | 'identifier_method'
1272
+ | 'account'
1273
+ | 'other';
1274
+
1275
+ /**
1276
+ * Additional context for the choice.
1277
+ */
1278
+ description?: string | null;
1279
+
1280
+ /**
1281
+ * Selector for the visible choice, when available.
1282
+ */
1283
+ observed_selector?: string | null;
1284
+ }
1285
+
1136
1286
  /**
1137
1287
  * A discovered form field
1138
1288
  */
@@ -1180,6 +1330,41 @@ export namespace ConnectionFollowResponse {
1180
1330
  required?: boolean;
1181
1331
  }
1182
1332
 
1333
+ /**
1334
+ * Canonical field awaiting user input.
1335
+ */
1336
+ export interface Field {
1337
+ /**
1338
+ * Stable field identifier for canonical submit.
1339
+ */
1340
+ id: string;
1341
+
1342
+ /**
1343
+ * Credential reference name to store the submitted value under.
1344
+ */
1345
+ ref: string;
1346
+
1347
+ /**
1348
+ * Managed-auth field type.
1349
+ */
1350
+ type: 'identifier' | 'password' | 'code' | 'totp_code' | 'totp_secret' | 'text';
1351
+
1352
+ /**
1353
+ * Human-readable label shown to the user.
1354
+ */
1355
+ label?: string;
1356
+
1357
+ /**
1358
+ * Selector for the visible field, when available.
1359
+ */
1360
+ observed_selector?: string | null;
1361
+
1362
+ /**
1363
+ * Whether this field is required.
1364
+ */
1365
+ required?: boolean;
1366
+ }
1367
+
1183
1368
  /**
1184
1369
  * An MFA method option for verification
1185
1370
  */
@@ -1562,6 +1747,11 @@ export namespace ConnectionLoginParams {
1562
1747
  }
1563
1748
 
1564
1749
  export interface ConnectionSubmitParams {
1750
+ /**
1751
+ * Canonical map of field ID to submitted value.
1752
+ */
1753
+ field_values?: { [key: string]: string };
1754
+
1565
1755
  /**
1566
1756
  * Map of field name to value
1567
1757
  */
@@ -1572,6 +1762,11 @@ export interface ConnectionSubmitParams {
1572
1762
  */
1573
1763
  mfa_option_id?: string;
1574
1764
 
1765
+ /**
1766
+ * Canonical choice ID selected by the user.
1767
+ */
1768
+ selected_choice_id?: string;
1769
+
1575
1770
  /**
1576
1771
  * The sign-in option ID to select (when sign_in_options were returned)
1577
1772
  */
@@ -295,6 +295,12 @@ export namespace BrowserPool {
295
295
  */
296
296
  stealth?: boolean;
297
297
 
298
+ /**
299
+ * Active telemetry configuration applied to browsers warmed into this pool, if
300
+ * any.
301
+ */
302
+ telemetry?: TelemetryAPI.BrowserTelemetryConfig | null;
303
+
298
304
  /**
299
305
  * Default idle timeout in seconds for browsers acquired from this pool before they
300
306
  * are destroyed. Minimum 10, maximum 259200 (72 hours).
@@ -555,6 +561,16 @@ export interface BrowserPoolCreateParams {
555
561
  */
556
562
  stealth?: boolean;
557
563
 
564
+ /**
565
+ * Telemetry configuration applied to browsers warmed into this pool. Set enabled
566
+ * to true to start capture using the default set, or provide browser category
567
+ * settings. If omitted, null, set to an empty object ({}), set to enabled: false
568
+ * without browser category settings, or all four CDP categories are explicitly
569
+ * disabled, no telemetry is configured on the pool. Only applied to newly-warmed
570
+ * browsers.
571
+ */
572
+ telemetry?: BrowserPoolCreateParams.Telemetry | null;
573
+
558
574
  /**
559
575
  * Default idle timeout in seconds for browsers acquired from this pool before they
560
576
  * are destroyed. Defaults to 600 seconds. Minimum 10, maximum 259200 (72 hours).
@@ -598,6 +614,41 @@ export namespace BrowserPoolCreateParams {
598
614
  */
599
615
  name?: string;
600
616
  }
617
+
618
+ /**
619
+ * Telemetry configuration applied to browsers warmed into this pool. Set enabled
620
+ * to true to start capture using the default set, or provide browser category
621
+ * settings. If omitted, null, set to an empty object ({}), set to enabled: false
622
+ * without browser category settings, or all four CDP categories are explicitly
623
+ * disabled, no telemetry is configured on the pool. Only applied to newly-warmed
624
+ * browsers.
625
+ */
626
+ export interface Telemetry {
627
+ /**
628
+ * Per-category capture flags. The operational categories (control, connection,
629
+ * system, captcha) are captured whenever telemetry is enabled; set one to
630
+ * enabled=false to opt out. The CDP categories (console, network, page,
631
+ * interaction) and screenshot are off by default; set enabled=true to opt in. On
632
+ * create, provided categories layer onto the default set. On update, provided
633
+ * categories merge onto the session's current config; when no telemetry is active
634
+ * this falls back to the default set (matching create). If browser is omitted or
635
+ * empty, the default set is used. A browser config that disables every category
636
+ * stops capture on update and starts no capture on create.
637
+ */
638
+ browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
639
+
640
+ /**
641
+ * Request shortcut for browser telemetry capture. True enables capture; with no
642
+ * browser category settings it captures the default set (control, connection,
643
+ * system, captcha), and any browser category settings are layered onto that
644
+ * default set. On update, enabled=true resolves the config fresh from the default
645
+ * set plus any provided categories, replacing the session's current selection
646
+ * rather than merging onto it; omit enabled to merge categories onto the current
647
+ * selection instead. False stops capture on update and starts no capture on
648
+ * create. enabled=false cannot be combined with browser category settings.
649
+ */
650
+ enabled?: boolean;
651
+ }
601
652
  }
602
653
 
603
654
  export interface BrowserPoolUpdateParams {
@@ -693,6 +744,17 @@ export interface BrowserPoolUpdateParams {
693
744
  */
694
745
  stealth?: boolean;
695
746
 
747
+ /**
748
+ * If provided, updates the pool's telemetry configuration. Omit, set to null, or
749
+ * set to an empty object ({}) to leave the existing configuration unchanged. Set
750
+ * enabled to true to enable capture using the default set. Set enabled to false to
751
+ * clear the pool's telemetry. Provide browser category settings for per-category
752
+ * updates, merged onto the pool's current configuration. Only applied to browsers
753
+ * warmed after the update; browsers already in the pool keep their configuration
754
+ * until discarded.
755
+ */
756
+ telemetry?: BrowserPoolUpdateParams.Telemetry | null;
757
+
696
758
  /**
697
759
  * If provided, replaces the default idle timeout in seconds for browsers acquired
698
760
  * from this pool before they are destroyed. Minimum 10, maximum 259200 (72 hours).
@@ -736,6 +798,42 @@ export namespace BrowserPoolUpdateParams {
736
798
  */
737
799
  name?: string;
738
800
  }
801
+
802
+ /**
803
+ * If provided, updates the pool's telemetry configuration. Omit, set to null, or
804
+ * set to an empty object ({}) to leave the existing configuration unchanged. Set
805
+ * enabled to true to enable capture using the default set. Set enabled to false to
806
+ * clear the pool's telemetry. Provide browser category settings for per-category
807
+ * updates, merged onto the pool's current configuration. Only applied to browsers
808
+ * warmed after the update; browsers already in the pool keep their configuration
809
+ * until discarded.
810
+ */
811
+ export interface Telemetry {
812
+ /**
813
+ * Per-category capture flags. The operational categories (control, connection,
814
+ * system, captcha) are captured whenever telemetry is enabled; set one to
815
+ * enabled=false to opt out. The CDP categories (console, network, page,
816
+ * interaction) and screenshot are off by default; set enabled=true to opt in. On
817
+ * create, provided categories layer onto the default set. On update, provided
818
+ * categories merge onto the session's current config; when no telemetry is active
819
+ * this falls back to the default set (matching create). If browser is omitted or
820
+ * empty, the default set is used. A browser config that disables every category
821
+ * stops capture on update and starts no capture on create.
822
+ */
823
+ browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
824
+
825
+ /**
826
+ * Request shortcut for browser telemetry capture. True enables capture; with no
827
+ * browser category settings it captures the default set (control, connection,
828
+ * system, captcha), and any browser category settings are layered onto that
829
+ * default set. On update, enabled=true resolves the config fresh from the default
830
+ * set plus any provided categories, replacing the session's current selection
831
+ * rather than merging onto it; omit enabled to merge categories onto the current
832
+ * selection instead. False stops capture on update and starts no capture on
833
+ * create. enabled=false cannot be combined with browser category settings.
834
+ */
835
+ enabled?: boolean;
836
+ }
739
837
  }
740
838
 
741
839
  export interface BrowserPoolListParams extends OffsetPaginationParams {
@@ -791,6 +889,57 @@ export interface BrowserPoolAcquireParams {
791
889
  * the browser is released back to the pool. Up to 50 pairs.
792
890
  */
793
891
  tags?: BrowsersAPI.Tags;
892
+
893
+ /**
894
+ * Telemetry override for the acquired browser, applied to this lease only. Merges
895
+ * onto the browser's current (pool-inherited) telemetry using the same
896
+ * per-category semantics as PATCH /browsers: provided categories override the
897
+ * current configuration, omitted categories are inherited. Set enabled to true to
898
+ * resolve the config fresh from the default set, or enabled to false to stop
899
+ * capture. When the browser is released back to the pool with reuse, its telemetry
900
+ * is reset to the pool's baseline, so the override does not carry over to the next
901
+ * lease.
902
+ */
903
+ telemetry?: BrowserPoolAcquireParams.Telemetry | null;
904
+ }
905
+
906
+ export namespace BrowserPoolAcquireParams {
907
+ /**
908
+ * Telemetry override for the acquired browser, applied to this lease only. Merges
909
+ * onto the browser's current (pool-inherited) telemetry using the same
910
+ * per-category semantics as PATCH /browsers: provided categories override the
911
+ * current configuration, omitted categories are inherited. Set enabled to true to
912
+ * resolve the config fresh from the default set, or enabled to false to stop
913
+ * capture. When the browser is released back to the pool with reuse, its telemetry
914
+ * is reset to the pool's baseline, so the override does not carry over to the next
915
+ * lease.
916
+ */
917
+ export interface Telemetry {
918
+ /**
919
+ * Per-category capture flags. The operational categories (control, connection,
920
+ * system, captcha) are captured whenever telemetry is enabled; set one to
921
+ * enabled=false to opt out. The CDP categories (console, network, page,
922
+ * interaction) and screenshot are off by default; set enabled=true to opt in. On
923
+ * create, provided categories layer onto the default set. On update, provided
924
+ * categories merge onto the session's current config; when no telemetry is active
925
+ * this falls back to the default set (matching create). If browser is omitted or
926
+ * empty, the default set is used. A browser config that disables every category
927
+ * stops capture on update and starts no capture on create.
928
+ */
929
+ browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
930
+
931
+ /**
932
+ * Request shortcut for browser telemetry capture. True enables capture; with no
933
+ * browser category settings it captures the default set (control, connection,
934
+ * system, captcha), and any browser category settings are layered onto that
935
+ * default set. On update, enabled=true resolves the config fresh from the default
936
+ * set plus any provided categories, replacing the session's current selection
937
+ * rather than merging onto it; omit enabled to merge categories onto the current
938
+ * selection instead. False stops capture on update and starts no capture on
939
+ * create. enabled=false cannot be combined with browser category settings.
940
+ */
941
+ enabled?: boolean;
942
+ }
794
943
  }
795
944
 
796
945
  export interface BrowserPoolReleaseParams {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.78.1'; // x-release-please-version
1
+ export const VERSION = '0.80.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.78.1";
1
+ export declare const VERSION = "0.80.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.78.1";
1
+ export declare const VERSION = "0.80.0";
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.78.1'; // x-release-please-version
4
+ exports.VERSION = '0.80.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.78.1'; // x-release-please-version
1
+ export const VERSION = '0.80.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map