@scalebrowser/sdk 0.5.0 → 0.7.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/dist/index.cjs CHANGED
@@ -294,6 +294,17 @@ var ControlApi = class extends ClientCore {
294
294
  throw err;
295
295
  }
296
296
  }
297
+ /**
298
+ * Which installation answered: its data directory and its binary.
299
+ *
300
+ * `health()` tells you something is there. This tells you WHAT, and the two are
301
+ * different questions whenever a machine holds more than one installation. The
302
+ * data directory is the identity; the address is not, because a port is a
303
+ * preference and a stale `runtime.json` can name one that moved.
304
+ */
305
+ getConnection(signal) {
306
+ return this.request("GET", "/v1/connection", void 0, { signal });
307
+ }
297
308
  /** "Is the daemon alive?" Public, needs no token. */
298
309
  health(signal) {
299
310
  return this.request("GET", "/health", void 0, { signal });
@@ -1524,6 +1535,7 @@ var ScalebrowserClient = class extends ClientCore {
1524
1535
  );
1525
1536
  }
1526
1537
  // ── Proxies (credentials write-only) ────────────────────────────────────────
1538
+ /** The list carries `used_by` per row; `getProxy` below does not. */
1527
1539
  listProxies(signal) {
1528
1540
  return this.request("GET", "/v1/proxies", void 0, { signal });
1529
1541
  }
@@ -1600,6 +1612,42 @@ var ScalebrowserClient = class extends ClientCore {
1600
1612
  throw err;
1601
1613
  }
1602
1614
  }
1615
+ // ── Remote access (the machine's own switch) ────────────────────────────────
1616
+ /**
1617
+ * Is remote access on for this machine?
1618
+ *
1619
+ * The switch is deliberately local: a chat service reaches this browser only
1620
+ * once somebody at the machine has turned it on. On a headless install there
1621
+ * is no UI to click, which is why it is here as well.
1622
+ */
1623
+ async getRemoteAccess(signal) {
1624
+ return this.request("GET", "/v1/remote", void 0, { signal });
1625
+ }
1626
+ /** Turn remote access on or off for this machine. */
1627
+ async setRemoteAccess(enabled, signal) {
1628
+ return this.request("PUT", "/v1/remote", { enabled }, { signal });
1629
+ }
1630
+ // ── Exit-address exclusivity (the machine's own switch) ─────────────────────
1631
+ /**
1632
+ * Does one exit address belong to one profile on this machine?
1633
+ *
1634
+ * Local like the remote-access switch above, and here for the same reason: on
1635
+ * a headless install there is no UI to click, and setting up fifty machines by
1636
+ * hand is not setting them up.
1637
+ */
1638
+ async getExitRule(signal) {
1639
+ return this.request("GET", "/v1/exit-rule", void 0, { signal });
1640
+ }
1641
+ /**
1642
+ * Turn the exit-address rule on or off for this machine.
1643
+ *
1644
+ * Off means two of your profiles can leave over the same address. Reach for it
1645
+ * when the provider hands out ONE address on purpose; a per-profile switch
1646
+ * exists for the narrower case (`updateProfile` with `exit_exclusive`).
1647
+ */
1648
+ async setExitRule(enabled, signal) {
1649
+ return this.request("PUT", "/v1/exit-rule", { enabled }, { signal });
1650
+ }
1603
1651
  // ── Events (SSE) ───────────────────────────────────────────────────────────
1604
1652
  /** Subscribe to lifecycle events. Returns an unsubscribe function. */
1605
1653
  subscribeEvents(handlers) {
@@ -1674,7 +1722,7 @@ var PROXY_KINDS = ["http", "socks5", "gateway"];
1674
1722
  var ROTATIONS = ["sticky", "rotating"];
1675
1723
 
1676
1724
  // src/index.ts
1677
- var VERSION = "0.5.0";
1725
+ var VERSION = "0.7.0";
1678
1726
 
1679
1727
  exports.ApiError = ApiError;
1680
1728
  exports.CdpError = CdpError;
package/dist/index.d.cts CHANGED
@@ -384,13 +384,20 @@ interface ShareLinkLocal {
384
384
  /**
385
385
  * Wire types: a 1:1 mirror of the daemon's serialized domain model
386
386
  * (`crates/core/src/model.rs`, `persona.rs`, `events.rs`) and the endpoint
387
- * contract in `docs/features/api.md`. Mirrored against `web-ui/src/api/types/`
388
- * (a directory of split files behind the `web-ui/src/api/types.ts` barrel), and
389
- * that mirror is ENFORCED: `web-ui/src/test/sdk-type-mirror.test.ts` compares
390
- * every shared exported declaration and goes red on drift. The Python SDK
391
- * (`sdks/python/src/scalebrowser/models*.py`) carries the same shapes by hand,
387
+ * contract in `docs/features/api.md`.
388
+ *
389
+ * THIS IS THE SOURCE, and since 2026-09-09 it is the only one on the TypeScript
390
+ * side: `web-ui/src/api/types.ts` re-exports these files through the
391
+ * `@scalebrowser/wire/*` alias instead of keeping a second copy (Decision 022).
392
+ * Before that the same 160 declarations stood twice, and each header named the
393
+ * other as the truth. The Python SDK
394
+ * (`sdks/python/src/scalebrowser/models*.py`) still carries the shapes by hand,
392
395
  * deliberately without a gate; a TS↔pydantic comparator is its own tool.
393
396
  *
397
+ * These files import nothing but each other, and that is load-bearing rather
398
+ * than tidy: the web-ui pulls them into a BROWSER bundle. A guard in
399
+ * `web-ui/src/test/sdk-type-mirror.test.ts` holds the property.
400
+ *
394
401
  * All Rust enums serialize `snake_case` (serde `rename_all`). Timestamps are
395
402
  * unix seconds (`number`, Rust `i64`). The truth for any disagreement is the
396
403
  * UNION of the Rust route shapes, never one serde struct (create/delete answer
@@ -442,6 +449,16 @@ interface Profile {
442
449
  proxy_id: string | null;
443
450
  geo_mode: GeoMode;
444
451
  expected_country: string | null;
452
+ /**
453
+ * Whether this profile claims its exit address for itself, so no other profile of
454
+ * the account starts on it (DEC-017). On for a new profile. Turn it off for a
455
+ * provider that hands out ONE address on purpose, a residential line you pay for
456
+ * or a whitelisted office address, where the rule would refuse every start after
457
+ * the first.
458
+ *
459
+ * Additive: a daemon predating it omits the field.
460
+ */
461
+ exit_exclusive?: boolean;
445
462
  data_dir: string;
446
463
  created_at: number;
447
464
  last_open_at: number | null;
@@ -718,12 +735,54 @@ interface Proxy {
718
735
  host: string;
719
736
  port: number;
720
737
  rotation: Rotation;
738
+ /**
739
+ * The operator's own name for this row, or `null` if they never gave one.
740
+ *
741
+ * The only field that tells two rows of one provider pool apart: kind, host,
742
+ * port and rotation are identical across a bought gateway, and the session tag
743
+ * that actually differs sits in the write-only username. Do not fall back to
744
+ * `last_exit_ip` for identity; the health check wrote it hours or days ago and
745
+ * a rotating exit no longer has that address.
746
+ */
747
+ label: string | null;
721
748
  last_exit_ip: string | null;
722
749
  last_country: string | null;
750
+ /**
751
+ * The operator string the geo probe answered with, for example
752
+ * `"AS21928 T-Mobile USA, Inc."`. Part of the same measurement as the fields
753
+ * around it: one check writes them, an endpoint change clears them together.
754
+ * The daemon derives the address kind from it, which decides how long an
755
+ * address stays reserved for a profile.
756
+ */
757
+ last_asn: string | null;
723
758
  last_check_at: number | null;
724
759
  healthy: boolean | null;
760
+ /** Round-trip latency of the last health check, in ms. */
761
+ last_latency_ms: number | null;
762
+ /**
763
+ * The row holds credentials that could not be decrypted (a database restored
764
+ * without its master key). Every launch through it fails closed, so a screen
765
+ * that shows only `healthy` paints such a row green while nothing can use it.
766
+ * Omitted by the daemon when false.
767
+ */
768
+ credentials_unreadable?: boolean;
725
769
  created_at: number;
726
770
  }
771
+ /**
772
+ * Who depends on one proxy, as `GET /v1/proxies` reports it per row.
773
+ *
774
+ * `count` is exact, `names` holds at most three. A proxy shared by a fleet must
775
+ * not drag every profile name into the listing, so showing the names without the
776
+ * count would turn "three of forty" into "these three".
777
+ */
778
+ interface ProxyUsage {
779
+ count: number;
780
+ names: string[];
781
+ }
782
+ /** A row of the proxy LIST: the proxy plus who uses it. The single GET has no `used_by`. */
783
+ interface ProxyRow extends Proxy {
784
+ used_by: ProxyUsage;
785
+ }
727
786
  /** Per-detector outcome; `skip` means the page could not be evaluated, NOT a pass. */
728
787
  type AuditVerdict = 'pass' | 'warn' | 'fail' | 'skip' | 'error';
729
788
  interface AuditDetectorReport {
@@ -889,7 +948,8 @@ interface ExitStatus {
889
948
  /**
890
949
  * The per-profile task list and the profile's own durable memory.
891
950
  *
892
- * Mirrors `web-ui/src/api/types/tasks.ts`, the shared source of contract truth.
951
+ * One of the files that ARE the contract; the web-ui reads them through
952
+ * `@scalebrowser/wire/*` rather than keeping a copy (Decision 022).
893
953
  */
894
954
  /**
895
955
  * Where a task stands.
@@ -1218,8 +1278,8 @@ declare function eventStream(params: StreamParams): AsyncIterableIterator<Lifecy
1218
1278
  * What the browser asks (interruptions), the bytes that go in and out
1219
1279
  * (artifacts), and what the licence says (account).
1220
1280
  *
1221
- * Interruption shapes mirror `web-ui/src/api/types/credentials.ts`, the shared
1222
- * source of contract truth.
1281
+ * One of the files that ARE the contract; the web-ui reads them through
1282
+ * `@scalebrowser/wire/*` rather than keeping a copy (Decision 022).
1223
1283
  */
1224
1284
  /** What an operator has taken out of an agent's hands. */
1225
1285
  type InterruptionLock = 'always_block' | 'always_allow' | 'agent_decides';
@@ -1291,6 +1351,32 @@ interface ArtifactBytes {
1291
1351
  /** Parsed out of `Content-Disposition`, when the daemon sent one. */
1292
1352
  filename: string | null;
1293
1353
  }
1354
+ /**
1355
+ * Which installation this daemon is: the data directory it serves and the binary
1356
+ * it runs from.
1357
+ *
1358
+ * One machine can hold several installations, and they are told apart by their
1359
+ * data directory, never by their address. A port is a preference: the desktop app
1360
+ * takes the first free one from 8787, and a `runtime.json` left behind by an
1361
+ * earlier daemon can name a port that something else now holds. Ask this before
1362
+ * assuming the daemon you reached is the one you meant.
1363
+ */
1364
+ interface Connection {
1365
+ /** The address the native API is bound to, as resolved. */
1366
+ native_addr: string;
1367
+ /** The data directory, in a form suitable for showing or for a command line. */
1368
+ data_dir: string;
1369
+ /**
1370
+ * The same directory, in the form two daemons compare. Case is folded on
1371
+ * Windows and links are resolved, so do not show this one to anybody; compare
1372
+ * it with another daemon's value and nothing else.
1373
+ */
1374
+ data_dir_key: string;
1375
+ /** Absolute path of the running binary, for a client that launches it over stdio. */
1376
+ executable?: string;
1377
+ /** The AdsPower-compatible adapter's address, when that adapter is enabled. */
1378
+ adspower_addr?: string;
1379
+ }
1294
1380
  /**
1295
1381
  * Licence state, for display.
1296
1382
  *
@@ -1332,6 +1418,39 @@ interface ReadyStatus {
1332
1418
  * launch-time question the preflight answers properly. */
1333
1419
  engines_dir: string;
1334
1420
  }
1421
+ /** What `GET /v1/remote` answers: the machine's own remote-access switch. */
1422
+ interface RemoteStatus {
1423
+ /** Is remote access on? */
1424
+ enabled: boolean;
1425
+ /** Did a person decide this, or is the configured default still standing? */
1426
+ explicit: boolean;
1427
+ /** The relay the tunnel goes to. */
1428
+ relay_url: string;
1429
+ /** Without a control-plane session there is no ticket and so no tunnel,
1430
+ * whatever the switch says. */
1431
+ ready: boolean;
1432
+ }
1433
+ /**
1434
+ * What `GET /v1/exit-rule` answers: the machine's own exit-address exclusivity
1435
+ * switch.
1436
+ *
1437
+ * On by default. Turn it off for a provider that hands out ONE address on
1438
+ * purpose, a residential line you pay for or a whitelisted office address, where
1439
+ * the rule would refuse every start after the first.
1440
+ */
1441
+ interface ExitRuleStatus {
1442
+ /** Does the rule apply on this machine? */
1443
+ enabled: boolean;
1444
+ /** Did a person decide this, or is the configured default still standing? */
1445
+ explicit: boolean;
1446
+ /**
1447
+ * How many profiles switched the rule off for themselves.
1448
+ *
1449
+ * A global "on" reads as "every profile is separated", and that stops being
1450
+ * true the moment one profile has its own switch off.
1451
+ */
1452
+ profiles_opted_out: number;
1453
+ }
1335
1454
 
1336
1455
  interface ScalebrowserClientOptions {
1337
1456
  /** Daemon base URL. Default `http://127.0.0.1:8787`. */
@@ -1399,6 +1518,15 @@ declare class ControlApi extends ClientCore {
1399
1518
  * connected or permitted. Same shape of tolerance as {@link getMetrics}.
1400
1519
  */
1401
1520
  getAccount(signal?: AbortSignal): Promise<Account>;
1521
+ /**
1522
+ * Which installation answered: its data directory and its binary.
1523
+ *
1524
+ * `health()` tells you something is there. This tells you WHAT, and the two are
1525
+ * different questions whenever a machine holds more than one installation. The
1526
+ * data directory is the identity; the address is not, because a port is a
1527
+ * preference and a stale `runtime.json` can name one that moved.
1528
+ */
1529
+ getConnection(signal?: AbortSignal): Promise<Connection>;
1402
1530
  /** "Is the daemon alive?" Public, needs no token. */
1403
1531
  health(signal?: AbortSignal): Promise<HealthStatus>;
1404
1532
  /** "Can it serve?" Local facts only; the control plane is deliberately not consulted. */
@@ -1441,6 +1569,21 @@ interface CreateProfileBody {
1441
1569
  host_mode?: HostMode;
1442
1570
  geo_mode?: GeoMode;
1443
1571
  expected_country?: string | null;
1572
+ /**
1573
+ * Draw the identity for this region (ISO-3166 alpha-2, e.g. `"DE"`): language,
1574
+ * timezone and speech voices come out of one row of the model together. Omit to
1575
+ * draw unconstrained, weighted the way the population is.
1576
+ *
1577
+ * This is not `expected_country`, which only checks the exit and never touches
1578
+ * the identity. And it is a starting value, not a promise: under the default
1579
+ * `geo_mode` the launch rewrites the region to the country the profile really
1580
+ * exits in, which is its proxy's, or with no proxy the machine's own. The
1581
+ * daemon refuses the pairings where that collision is already known.
1582
+ *
1583
+ * Set only at create. A region the model cannot draw is a 400 listing the ones
1584
+ * it can.
1585
+ */
1586
+ persona_country?: string;
1444
1587
  group_id?: string | null;
1445
1588
  proxy_id?: string | null;
1446
1589
  }
@@ -1449,7 +1592,14 @@ interface CreateProfileBody {
1449
1592
  * time (C4/C5): a DIFFERING `host_mode` is refused with 400, an unchanged echo is
1450
1593
  * accepted. Changing a tier requires delete + recreate.
1451
1594
  */
1452
- type UpdateProfileBody = Omit<Partial<CreateProfileBody>, "host_mode" | "seed">;
1595
+ type UpdateProfileBody = Omit<Partial<CreateProfileBody>, "host_mode" | "seed" | "persona_country"> & {
1596
+ /**
1597
+ * Turn the exit-address rule off for this profile (DEC-017). Deliberately not
1598
+ * part of `CreateProfileBody`: a new profile always claims its address, and
1599
+ * switching that off is a later, deliberate act for a setup that needs it.
1600
+ */
1601
+ exit_exclusive?: boolean;
1602
+ };
1453
1603
  interface StartProfileBody {
1454
1604
  headless?: boolean;
1455
1605
  }
@@ -1498,6 +1648,12 @@ interface CreateProxyBody {
1498
1648
  username?: string | null;
1499
1649
  password?: string | null;
1500
1650
  rotation?: Rotation;
1651
+ /**
1652
+ * The operator's own name for the row. Trimmed by the daemon; a blank string is
1653
+ * stored as null. On an update the field carries three states: omit the key to
1654
+ * leave the name alone, send `null` to clear it, send a string to set it.
1655
+ */
1656
+ label?: string | null;
1501
1657
  }
1502
1658
  type UpdateProxyBody = Partial<CreateProxyBody>;
1503
1659
  /**
@@ -1634,9 +1790,10 @@ declare class ExtensionsApi extends ClientCore {
1634
1790
  * The account layer: mailboxes, passkeys and the one door a cookie value leaves
1635
1791
  * through.
1636
1792
  *
1637
- * Mailbox and passkey shapes mirror `web-ui/src/api/types/{inboxes,credentials}.ts`,
1638
- * the shared source of contract truth. The cookie reveal has no UI counterpart:
1639
- * it is a REST-only route deliberately kept off every screen.
1793
+ * One of the files that ARE the contract; the web-ui reads them through
1794
+ * `@scalebrowser/wire/*` rather than keeping a copy (Decision 022). The cookie
1795
+ * reveal has no UI counterpart: it is a REST-only route deliberately kept off
1796
+ * every screen.
1640
1797
  */
1641
1798
  /** One configured mailbox. The password is never sent back. */
1642
1799
  interface Inbox {
@@ -2039,7 +2196,8 @@ declare class TasksApi extends ClientCore {
2039
2196
  * the live event stream carries them, and the run list describes the same rows.
2040
2197
  * A second copy would let the two drift apart while both looked right.
2041
2198
  *
2042
- * Mirrors `web-ui/src/api/types/runs.ts`, the shared source of contract truth.
2199
+ * One of the files that ARE the contract; the web-ui reads them through
2200
+ * `@scalebrowser/wire/*` rather than keeping a copy (Decision 022).
2043
2201
  */
2044
2202
 
2045
2203
  /** Who made the outcome claim. `derived` means nobody did. */
@@ -2499,7 +2657,8 @@ declare class ScalebrowserClient extends ClientCore {
2499
2657
  * drifts the moment that model changes and every create 400s.
2500
2658
  */
2501
2659
  getPersonaConstraints(signal?: AbortSignal): Promise<PersonaConstraintOptions>;
2502
- listProxies(signal?: AbortSignal): Promise<Proxy[]>;
2660
+ /** The list carries `used_by` per row; `getProxy` below does not. */
2661
+ listProxies(signal?: AbortSignal): Promise<ProxyRow[]>;
2503
2662
  getProxy(id: string, signal?: AbortSignal): Promise<Proxy>;
2504
2663
  createProxy(body: CreateProxyBody): Promise<Proxy>;
2505
2664
  updateProxy(id: string, body: UpdateProxyBody): Promise<Proxy>;
@@ -2527,6 +2686,32 @@ declare class ScalebrowserClient extends ClientCore {
2527
2686
  importSession(profileId: string, body: SessionImportBody): Promise<unknown>;
2528
2687
  sendInput(profileId: string, body: TrustedInputBody): Promise<unknown>;
2529
2688
  getMetrics(signal?: AbortSignal): Promise<Metrics>;
2689
+ /**
2690
+ * Is remote access on for this machine?
2691
+ *
2692
+ * The switch is deliberately local: a chat service reaches this browser only
2693
+ * once somebody at the machine has turned it on. On a headless install there
2694
+ * is no UI to click, which is why it is here as well.
2695
+ */
2696
+ getRemoteAccess(signal?: AbortSignal): Promise<RemoteStatus>;
2697
+ /** Turn remote access on or off for this machine. */
2698
+ setRemoteAccess(enabled: boolean, signal?: AbortSignal): Promise<RemoteStatus>;
2699
+ /**
2700
+ * Does one exit address belong to one profile on this machine?
2701
+ *
2702
+ * Local like the remote-access switch above, and here for the same reason: on
2703
+ * a headless install there is no UI to click, and setting up fifty machines by
2704
+ * hand is not setting them up.
2705
+ */
2706
+ getExitRule(signal?: AbortSignal): Promise<ExitRuleStatus>;
2707
+ /**
2708
+ * Turn the exit-address rule on or off for this machine.
2709
+ *
2710
+ * Off means two of your profiles can leave over the same address. Reach for it
2711
+ * when the provider hands out ONE address on purpose; a per-profile switch
2712
+ * exists for the narrower case (`updateProfile` with `exit_exclusive`).
2713
+ */
2714
+ setExitRule(enabled: boolean, signal?: AbortSignal): Promise<ExitRuleStatus>;
2530
2715
  /** Subscribe to lifecycle events. Returns an unsubscribe function. */
2531
2716
  subscribeEvents(handlers: StreamHandlers): () => void;
2532
2717
  /** `for await (const event of client.events())` over lifecycle events. */
@@ -2639,6 +2824,6 @@ declare function errorMessage(err: unknown): string;
2639
2824
  * ```
2640
2825
  */
2641
2826
 
2642
- declare const VERSION = "0.5.0";
2827
+ declare const VERSION = "0.7.0";
2643
2828
 
2644
- export { type Account, type ActivitySnapshot, type AgentRun, ApiError, type ApiErrorBody, type ArtifactBytes, type ArtifactPutResult, type AttachOptions, type AudioStatus, type AuditDetectorReport, type AuditReport, type AuditStatus, type AuditVerdict, type BindInboxBody, type CdpConnectOptions, CdpError, type CdpEvent, CdpSession, type Chapter, type ClickOptions, type CodecsStatus, type CreateGroupBody, type CreateInboxBody, type CreatePresetBody, type CreateTasksBody, type CreateTasksResult, DEFAULT_CAPACITY, type DeleteInterruptionRuleParams, type EffectiveInterruptionLock, ErrorCode, type ErrorCodeValue, type EvaluateOptions, type ExitClaim, type ExitScope, type ExitStatus, type ExportPresetName, type ExtraOutput, type FetchLike, GEO_MODES, type GeoMode, type GoalSource, type Group, HOST_MODES, type HealthStatus, type HostMode, type Inbox, type InboxBinding, type InboxBindings, type InboxChannel, type InputClient, type InterruptionChoice, type InterruptionLock, type InterruptionLockRow, type InterruptionLockView, type InterruptionRuleRow, type LaunchHandle, type ListRunsParams, type ListStepsParams, type ListTasksParams, type ListVideosParams, type MediaAsset, type MediaKind, type MusicBed, type NarrationLine, type NavigateOptions, NetworkError, type OsFamily, type OutcomeSource, PROXY_KINDS, type PasskeyRow, type PatchTaskBody, type PersonaConstraintOptions, type Preset, type PresetConfig, type PresetConstraints, type PreviewHidden, type PreviewMoment, type Profile, type ProfileActivity, type ProfileMemory, type ProfileTask, type ProtectionLevel, type ProtectionStatus, type Proxy, type ProxyKind, ROTATIONS, RUNTIME_STATES, type ReadyStatus, type Recording, type RecordingKind, type RecordingState, type RenderProgress, type RenderRequestBody, type RenderStage, type RevealCookiesBody, type RevealCookiesResult, type RevealedCookie, type Rotation, type RunActor, type RunOutcome, type RunStep, type RuntimeState, ScalebrowserClient, type ScalebrowserClientOptions, ScalebrowserError, type ScrollOptions, type SecretBindingMode, type SecretDeleteResult, type SecretKind, type SecretListResult, type SecretOrigin, type SecretPatchBody, type SecretRow, type SecretRunBody, type SecretRunMention, type SecretRunResult, type SecretScrubResult, type SecretState, type SessionExportBody, type SessionExportResult, type SessionImportBody, type SessionKind, type SetInterruptionLockBody, type SetInterruptionRuleBody, type ShareLinkLocal, type ShotFocus, type ShotIntent, type StepKind, type StepTarget, type StreamHandlers, type StreamParams, type StreamStatus, type TaskState, type TimestampState, type TranscriptWord, type TrustedInputBody, type TtsProviderView, type TtsVerifyResult, type UpdateGroupBody, type UpdateInboxBody, type UpdatePresetBody, VERSION, type Video, type VideoAccessGrant, type VideoAssetName, type VideoAssets, type VideoBackground, type VideoCard, type VideoDestination, type VideoFlags, type VideoPreset, type VideoPresetClip, type VideoPresetClipBody, type VideoPresetClipProgress, type VideoPresetClipStarted, type VideoPresetConfig, type VideoPresetPreview, type VideoPresetPreviewBody, type VideoState, type VideosPage, type VideosStorage, type WriteMemoryBody, deriveMetricsFromProfiles, errorMessage, eventStream, openCdpSession, parseSseFrame, subscribeEvents };
2829
+ export { type Account, type ActivitySnapshot, type AgentRun, ApiError, type ApiErrorBody, type ArtifactBytes, type ArtifactPutResult, type AttachOptions, type AudioStatus, type AuditDetectorReport, type AuditReport, type AuditStatus, type AuditVerdict, type BindInboxBody, type CdpConnectOptions, CdpError, type CdpEvent, CdpSession, type Chapter, type ClickOptions, type CodecsStatus, type Connection, type CreateGroupBody, type CreateInboxBody, type CreatePresetBody, type CreateTasksBody, type CreateTasksResult, DEFAULT_CAPACITY, type DeleteInterruptionRuleParams, type EffectiveInterruptionLock, ErrorCode, type ErrorCodeValue, type EvaluateOptions, type ExitClaim, type ExitRuleStatus, type ExitScope, type ExitStatus, type ExportPresetName, type ExtraOutput, type FetchLike, GEO_MODES, type GeoMode, type GoalSource, type Group, HOST_MODES, type HealthStatus, type HostMode, type Inbox, type InboxBinding, type InboxBindings, type InboxChannel, type InputClient, type InterruptionChoice, type InterruptionLock, type InterruptionLockRow, type InterruptionLockView, type InterruptionRuleRow, type LaunchHandle, type ListRunsParams, type ListStepsParams, type ListTasksParams, type ListVideosParams, type MediaAsset, type MediaKind, type MusicBed, type NarrationLine, type NavigateOptions, NetworkError, type OsFamily, type OutcomeSource, PROXY_KINDS, type PasskeyRow, type PatchTaskBody, type PersonaConstraintOptions, type Preset, type PresetConfig, type PresetConstraints, type PreviewHidden, type PreviewMoment, type Profile, type ProfileActivity, type ProfileMemory, type ProfileTask, type ProtectionLevel, type ProtectionStatus, type Proxy, type ProxyKind, type ProxyRow, type ProxyUsage, ROTATIONS, RUNTIME_STATES, type ReadyStatus, type Recording, type RecordingKind, type RecordingState, type RemoteStatus, type RenderProgress, type RenderRequestBody, type RenderStage, type RevealCookiesBody, type RevealCookiesResult, type RevealedCookie, type Rotation, type RunActor, type RunOutcome, type RunStep, type RuntimeState, ScalebrowserClient, type ScalebrowserClientOptions, ScalebrowserError, type ScrollOptions, type SecretBindingMode, type SecretDeleteResult, type SecretKind, type SecretListResult, type SecretOrigin, type SecretPatchBody, type SecretRow, type SecretRunBody, type SecretRunMention, type SecretRunResult, type SecretScrubResult, type SecretState, type SessionExportBody, type SessionExportResult, type SessionImportBody, type SessionKind, type SetInterruptionLockBody, type SetInterruptionRuleBody, type ShareLinkLocal, type ShotFocus, type ShotIntent, type StepKind, type StepTarget, type StreamHandlers, type StreamParams, type StreamStatus, type TaskState, type TimestampState, type TranscriptWord, type TrustedInputBody, type TtsProviderView, type TtsVerifyResult, type UpdateGroupBody, type UpdateInboxBody, type UpdatePresetBody, VERSION, type Video, type VideoAccessGrant, type VideoAssetName, type VideoAssets, type VideoBackground, type VideoCard, type VideoDestination, type VideoFlags, type VideoPreset, type VideoPresetClip, type VideoPresetClipBody, type VideoPresetClipProgress, type VideoPresetClipStarted, type VideoPresetConfig, type VideoPresetPreview, type VideoPresetPreviewBody, type VideoState, type VideosPage, type VideosStorage, type WriteMemoryBody, deriveMetricsFromProfiles, errorMessage, eventStream, openCdpSession, parseSseFrame, subscribeEvents };
package/dist/index.d.ts CHANGED
@@ -384,13 +384,20 @@ interface ShareLinkLocal {
384
384
  /**
385
385
  * Wire types: a 1:1 mirror of the daemon's serialized domain model
386
386
  * (`crates/core/src/model.rs`, `persona.rs`, `events.rs`) and the endpoint
387
- * contract in `docs/features/api.md`. Mirrored against `web-ui/src/api/types/`
388
- * (a directory of split files behind the `web-ui/src/api/types.ts` barrel), and
389
- * that mirror is ENFORCED: `web-ui/src/test/sdk-type-mirror.test.ts` compares
390
- * every shared exported declaration and goes red on drift. The Python SDK
391
- * (`sdks/python/src/scalebrowser/models*.py`) carries the same shapes by hand,
387
+ * contract in `docs/features/api.md`.
388
+ *
389
+ * THIS IS THE SOURCE, and since 2026-09-09 it is the only one on the TypeScript
390
+ * side: `web-ui/src/api/types.ts` re-exports these files through the
391
+ * `@scalebrowser/wire/*` alias instead of keeping a second copy (Decision 022).
392
+ * Before that the same 160 declarations stood twice, and each header named the
393
+ * other as the truth. The Python SDK
394
+ * (`sdks/python/src/scalebrowser/models*.py`) still carries the shapes by hand,
392
395
  * deliberately without a gate; a TS↔pydantic comparator is its own tool.
393
396
  *
397
+ * These files import nothing but each other, and that is load-bearing rather
398
+ * than tidy: the web-ui pulls them into a BROWSER bundle. A guard in
399
+ * `web-ui/src/test/sdk-type-mirror.test.ts` holds the property.
400
+ *
394
401
  * All Rust enums serialize `snake_case` (serde `rename_all`). Timestamps are
395
402
  * unix seconds (`number`, Rust `i64`). The truth for any disagreement is the
396
403
  * UNION of the Rust route shapes, never one serde struct (create/delete answer
@@ -442,6 +449,16 @@ interface Profile {
442
449
  proxy_id: string | null;
443
450
  geo_mode: GeoMode;
444
451
  expected_country: string | null;
452
+ /**
453
+ * Whether this profile claims its exit address for itself, so no other profile of
454
+ * the account starts on it (DEC-017). On for a new profile. Turn it off for a
455
+ * provider that hands out ONE address on purpose, a residential line you pay for
456
+ * or a whitelisted office address, where the rule would refuse every start after
457
+ * the first.
458
+ *
459
+ * Additive: a daemon predating it omits the field.
460
+ */
461
+ exit_exclusive?: boolean;
445
462
  data_dir: string;
446
463
  created_at: number;
447
464
  last_open_at: number | null;
@@ -718,12 +735,54 @@ interface Proxy {
718
735
  host: string;
719
736
  port: number;
720
737
  rotation: Rotation;
738
+ /**
739
+ * The operator's own name for this row, or `null` if they never gave one.
740
+ *
741
+ * The only field that tells two rows of one provider pool apart: kind, host,
742
+ * port and rotation are identical across a bought gateway, and the session tag
743
+ * that actually differs sits in the write-only username. Do not fall back to
744
+ * `last_exit_ip` for identity; the health check wrote it hours or days ago and
745
+ * a rotating exit no longer has that address.
746
+ */
747
+ label: string | null;
721
748
  last_exit_ip: string | null;
722
749
  last_country: string | null;
750
+ /**
751
+ * The operator string the geo probe answered with, for example
752
+ * `"AS21928 T-Mobile USA, Inc."`. Part of the same measurement as the fields
753
+ * around it: one check writes them, an endpoint change clears them together.
754
+ * The daemon derives the address kind from it, which decides how long an
755
+ * address stays reserved for a profile.
756
+ */
757
+ last_asn: string | null;
723
758
  last_check_at: number | null;
724
759
  healthy: boolean | null;
760
+ /** Round-trip latency of the last health check, in ms. */
761
+ last_latency_ms: number | null;
762
+ /**
763
+ * The row holds credentials that could not be decrypted (a database restored
764
+ * without its master key). Every launch through it fails closed, so a screen
765
+ * that shows only `healthy` paints such a row green while nothing can use it.
766
+ * Omitted by the daemon when false.
767
+ */
768
+ credentials_unreadable?: boolean;
725
769
  created_at: number;
726
770
  }
771
+ /**
772
+ * Who depends on one proxy, as `GET /v1/proxies` reports it per row.
773
+ *
774
+ * `count` is exact, `names` holds at most three. A proxy shared by a fleet must
775
+ * not drag every profile name into the listing, so showing the names without the
776
+ * count would turn "three of forty" into "these three".
777
+ */
778
+ interface ProxyUsage {
779
+ count: number;
780
+ names: string[];
781
+ }
782
+ /** A row of the proxy LIST: the proxy plus who uses it. The single GET has no `used_by`. */
783
+ interface ProxyRow extends Proxy {
784
+ used_by: ProxyUsage;
785
+ }
727
786
  /** Per-detector outcome; `skip` means the page could not be evaluated, NOT a pass. */
728
787
  type AuditVerdict = 'pass' | 'warn' | 'fail' | 'skip' | 'error';
729
788
  interface AuditDetectorReport {
@@ -889,7 +948,8 @@ interface ExitStatus {
889
948
  /**
890
949
  * The per-profile task list and the profile's own durable memory.
891
950
  *
892
- * Mirrors `web-ui/src/api/types/tasks.ts`, the shared source of contract truth.
951
+ * One of the files that ARE the contract; the web-ui reads them through
952
+ * `@scalebrowser/wire/*` rather than keeping a copy (Decision 022).
893
953
  */
894
954
  /**
895
955
  * Where a task stands.
@@ -1218,8 +1278,8 @@ declare function eventStream(params: StreamParams): AsyncIterableIterator<Lifecy
1218
1278
  * What the browser asks (interruptions), the bytes that go in and out
1219
1279
  * (artifacts), and what the licence says (account).
1220
1280
  *
1221
- * Interruption shapes mirror `web-ui/src/api/types/credentials.ts`, the shared
1222
- * source of contract truth.
1281
+ * One of the files that ARE the contract; the web-ui reads them through
1282
+ * `@scalebrowser/wire/*` rather than keeping a copy (Decision 022).
1223
1283
  */
1224
1284
  /** What an operator has taken out of an agent's hands. */
1225
1285
  type InterruptionLock = 'always_block' | 'always_allow' | 'agent_decides';
@@ -1291,6 +1351,32 @@ interface ArtifactBytes {
1291
1351
  /** Parsed out of `Content-Disposition`, when the daemon sent one. */
1292
1352
  filename: string | null;
1293
1353
  }
1354
+ /**
1355
+ * Which installation this daemon is: the data directory it serves and the binary
1356
+ * it runs from.
1357
+ *
1358
+ * One machine can hold several installations, and they are told apart by their
1359
+ * data directory, never by their address. A port is a preference: the desktop app
1360
+ * takes the first free one from 8787, and a `runtime.json` left behind by an
1361
+ * earlier daemon can name a port that something else now holds. Ask this before
1362
+ * assuming the daemon you reached is the one you meant.
1363
+ */
1364
+ interface Connection {
1365
+ /** The address the native API is bound to, as resolved. */
1366
+ native_addr: string;
1367
+ /** The data directory, in a form suitable for showing or for a command line. */
1368
+ data_dir: string;
1369
+ /**
1370
+ * The same directory, in the form two daemons compare. Case is folded on
1371
+ * Windows and links are resolved, so do not show this one to anybody; compare
1372
+ * it with another daemon's value and nothing else.
1373
+ */
1374
+ data_dir_key: string;
1375
+ /** Absolute path of the running binary, for a client that launches it over stdio. */
1376
+ executable?: string;
1377
+ /** The AdsPower-compatible adapter's address, when that adapter is enabled. */
1378
+ adspower_addr?: string;
1379
+ }
1294
1380
  /**
1295
1381
  * Licence state, for display.
1296
1382
  *
@@ -1332,6 +1418,39 @@ interface ReadyStatus {
1332
1418
  * launch-time question the preflight answers properly. */
1333
1419
  engines_dir: string;
1334
1420
  }
1421
+ /** What `GET /v1/remote` answers: the machine's own remote-access switch. */
1422
+ interface RemoteStatus {
1423
+ /** Is remote access on? */
1424
+ enabled: boolean;
1425
+ /** Did a person decide this, or is the configured default still standing? */
1426
+ explicit: boolean;
1427
+ /** The relay the tunnel goes to. */
1428
+ relay_url: string;
1429
+ /** Without a control-plane session there is no ticket and so no tunnel,
1430
+ * whatever the switch says. */
1431
+ ready: boolean;
1432
+ }
1433
+ /**
1434
+ * What `GET /v1/exit-rule` answers: the machine's own exit-address exclusivity
1435
+ * switch.
1436
+ *
1437
+ * On by default. Turn it off for a provider that hands out ONE address on
1438
+ * purpose, a residential line you pay for or a whitelisted office address, where
1439
+ * the rule would refuse every start after the first.
1440
+ */
1441
+ interface ExitRuleStatus {
1442
+ /** Does the rule apply on this machine? */
1443
+ enabled: boolean;
1444
+ /** Did a person decide this, or is the configured default still standing? */
1445
+ explicit: boolean;
1446
+ /**
1447
+ * How many profiles switched the rule off for themselves.
1448
+ *
1449
+ * A global "on" reads as "every profile is separated", and that stops being
1450
+ * true the moment one profile has its own switch off.
1451
+ */
1452
+ profiles_opted_out: number;
1453
+ }
1335
1454
 
1336
1455
  interface ScalebrowserClientOptions {
1337
1456
  /** Daemon base URL. Default `http://127.0.0.1:8787`. */
@@ -1399,6 +1518,15 @@ declare class ControlApi extends ClientCore {
1399
1518
  * connected or permitted. Same shape of tolerance as {@link getMetrics}.
1400
1519
  */
1401
1520
  getAccount(signal?: AbortSignal): Promise<Account>;
1521
+ /**
1522
+ * Which installation answered: its data directory and its binary.
1523
+ *
1524
+ * `health()` tells you something is there. This tells you WHAT, and the two are
1525
+ * different questions whenever a machine holds more than one installation. The
1526
+ * data directory is the identity; the address is not, because a port is a
1527
+ * preference and a stale `runtime.json` can name one that moved.
1528
+ */
1529
+ getConnection(signal?: AbortSignal): Promise<Connection>;
1402
1530
  /** "Is the daemon alive?" Public, needs no token. */
1403
1531
  health(signal?: AbortSignal): Promise<HealthStatus>;
1404
1532
  /** "Can it serve?" Local facts only; the control plane is deliberately not consulted. */
@@ -1441,6 +1569,21 @@ interface CreateProfileBody {
1441
1569
  host_mode?: HostMode;
1442
1570
  geo_mode?: GeoMode;
1443
1571
  expected_country?: string | null;
1572
+ /**
1573
+ * Draw the identity for this region (ISO-3166 alpha-2, e.g. `"DE"`): language,
1574
+ * timezone and speech voices come out of one row of the model together. Omit to
1575
+ * draw unconstrained, weighted the way the population is.
1576
+ *
1577
+ * This is not `expected_country`, which only checks the exit and never touches
1578
+ * the identity. And it is a starting value, not a promise: under the default
1579
+ * `geo_mode` the launch rewrites the region to the country the profile really
1580
+ * exits in, which is its proxy's, or with no proxy the machine's own. The
1581
+ * daemon refuses the pairings where that collision is already known.
1582
+ *
1583
+ * Set only at create. A region the model cannot draw is a 400 listing the ones
1584
+ * it can.
1585
+ */
1586
+ persona_country?: string;
1444
1587
  group_id?: string | null;
1445
1588
  proxy_id?: string | null;
1446
1589
  }
@@ -1449,7 +1592,14 @@ interface CreateProfileBody {
1449
1592
  * time (C4/C5): a DIFFERING `host_mode` is refused with 400, an unchanged echo is
1450
1593
  * accepted. Changing a tier requires delete + recreate.
1451
1594
  */
1452
- type UpdateProfileBody = Omit<Partial<CreateProfileBody>, "host_mode" | "seed">;
1595
+ type UpdateProfileBody = Omit<Partial<CreateProfileBody>, "host_mode" | "seed" | "persona_country"> & {
1596
+ /**
1597
+ * Turn the exit-address rule off for this profile (DEC-017). Deliberately not
1598
+ * part of `CreateProfileBody`: a new profile always claims its address, and
1599
+ * switching that off is a later, deliberate act for a setup that needs it.
1600
+ */
1601
+ exit_exclusive?: boolean;
1602
+ };
1453
1603
  interface StartProfileBody {
1454
1604
  headless?: boolean;
1455
1605
  }
@@ -1498,6 +1648,12 @@ interface CreateProxyBody {
1498
1648
  username?: string | null;
1499
1649
  password?: string | null;
1500
1650
  rotation?: Rotation;
1651
+ /**
1652
+ * The operator's own name for the row. Trimmed by the daemon; a blank string is
1653
+ * stored as null. On an update the field carries three states: omit the key to
1654
+ * leave the name alone, send `null` to clear it, send a string to set it.
1655
+ */
1656
+ label?: string | null;
1501
1657
  }
1502
1658
  type UpdateProxyBody = Partial<CreateProxyBody>;
1503
1659
  /**
@@ -1634,9 +1790,10 @@ declare class ExtensionsApi extends ClientCore {
1634
1790
  * The account layer: mailboxes, passkeys and the one door a cookie value leaves
1635
1791
  * through.
1636
1792
  *
1637
- * Mailbox and passkey shapes mirror `web-ui/src/api/types/{inboxes,credentials}.ts`,
1638
- * the shared source of contract truth. The cookie reveal has no UI counterpart:
1639
- * it is a REST-only route deliberately kept off every screen.
1793
+ * One of the files that ARE the contract; the web-ui reads them through
1794
+ * `@scalebrowser/wire/*` rather than keeping a copy (Decision 022). The cookie
1795
+ * reveal has no UI counterpart: it is a REST-only route deliberately kept off
1796
+ * every screen.
1640
1797
  */
1641
1798
  /** One configured mailbox. The password is never sent back. */
1642
1799
  interface Inbox {
@@ -2039,7 +2196,8 @@ declare class TasksApi extends ClientCore {
2039
2196
  * the live event stream carries them, and the run list describes the same rows.
2040
2197
  * A second copy would let the two drift apart while both looked right.
2041
2198
  *
2042
- * Mirrors `web-ui/src/api/types/runs.ts`, the shared source of contract truth.
2199
+ * One of the files that ARE the contract; the web-ui reads them through
2200
+ * `@scalebrowser/wire/*` rather than keeping a copy (Decision 022).
2043
2201
  */
2044
2202
 
2045
2203
  /** Who made the outcome claim. `derived` means nobody did. */
@@ -2499,7 +2657,8 @@ declare class ScalebrowserClient extends ClientCore {
2499
2657
  * drifts the moment that model changes and every create 400s.
2500
2658
  */
2501
2659
  getPersonaConstraints(signal?: AbortSignal): Promise<PersonaConstraintOptions>;
2502
- listProxies(signal?: AbortSignal): Promise<Proxy[]>;
2660
+ /** The list carries `used_by` per row; `getProxy` below does not. */
2661
+ listProxies(signal?: AbortSignal): Promise<ProxyRow[]>;
2503
2662
  getProxy(id: string, signal?: AbortSignal): Promise<Proxy>;
2504
2663
  createProxy(body: CreateProxyBody): Promise<Proxy>;
2505
2664
  updateProxy(id: string, body: UpdateProxyBody): Promise<Proxy>;
@@ -2527,6 +2686,32 @@ declare class ScalebrowserClient extends ClientCore {
2527
2686
  importSession(profileId: string, body: SessionImportBody): Promise<unknown>;
2528
2687
  sendInput(profileId: string, body: TrustedInputBody): Promise<unknown>;
2529
2688
  getMetrics(signal?: AbortSignal): Promise<Metrics>;
2689
+ /**
2690
+ * Is remote access on for this machine?
2691
+ *
2692
+ * The switch is deliberately local: a chat service reaches this browser only
2693
+ * once somebody at the machine has turned it on. On a headless install there
2694
+ * is no UI to click, which is why it is here as well.
2695
+ */
2696
+ getRemoteAccess(signal?: AbortSignal): Promise<RemoteStatus>;
2697
+ /** Turn remote access on or off for this machine. */
2698
+ setRemoteAccess(enabled: boolean, signal?: AbortSignal): Promise<RemoteStatus>;
2699
+ /**
2700
+ * Does one exit address belong to one profile on this machine?
2701
+ *
2702
+ * Local like the remote-access switch above, and here for the same reason: on
2703
+ * a headless install there is no UI to click, and setting up fifty machines by
2704
+ * hand is not setting them up.
2705
+ */
2706
+ getExitRule(signal?: AbortSignal): Promise<ExitRuleStatus>;
2707
+ /**
2708
+ * Turn the exit-address rule on or off for this machine.
2709
+ *
2710
+ * Off means two of your profiles can leave over the same address. Reach for it
2711
+ * when the provider hands out ONE address on purpose; a per-profile switch
2712
+ * exists for the narrower case (`updateProfile` with `exit_exclusive`).
2713
+ */
2714
+ setExitRule(enabled: boolean, signal?: AbortSignal): Promise<ExitRuleStatus>;
2530
2715
  /** Subscribe to lifecycle events. Returns an unsubscribe function. */
2531
2716
  subscribeEvents(handlers: StreamHandlers): () => void;
2532
2717
  /** `for await (const event of client.events())` over lifecycle events. */
@@ -2639,6 +2824,6 @@ declare function errorMessage(err: unknown): string;
2639
2824
  * ```
2640
2825
  */
2641
2826
 
2642
- declare const VERSION = "0.5.0";
2827
+ declare const VERSION = "0.7.0";
2643
2828
 
2644
- export { type Account, type ActivitySnapshot, type AgentRun, ApiError, type ApiErrorBody, type ArtifactBytes, type ArtifactPutResult, type AttachOptions, type AudioStatus, type AuditDetectorReport, type AuditReport, type AuditStatus, type AuditVerdict, type BindInboxBody, type CdpConnectOptions, CdpError, type CdpEvent, CdpSession, type Chapter, type ClickOptions, type CodecsStatus, type CreateGroupBody, type CreateInboxBody, type CreatePresetBody, type CreateTasksBody, type CreateTasksResult, DEFAULT_CAPACITY, type DeleteInterruptionRuleParams, type EffectiveInterruptionLock, ErrorCode, type ErrorCodeValue, type EvaluateOptions, type ExitClaim, type ExitScope, type ExitStatus, type ExportPresetName, type ExtraOutput, type FetchLike, GEO_MODES, type GeoMode, type GoalSource, type Group, HOST_MODES, type HealthStatus, type HostMode, type Inbox, type InboxBinding, type InboxBindings, type InboxChannel, type InputClient, type InterruptionChoice, type InterruptionLock, type InterruptionLockRow, type InterruptionLockView, type InterruptionRuleRow, type LaunchHandle, type ListRunsParams, type ListStepsParams, type ListTasksParams, type ListVideosParams, type MediaAsset, type MediaKind, type MusicBed, type NarrationLine, type NavigateOptions, NetworkError, type OsFamily, type OutcomeSource, PROXY_KINDS, type PasskeyRow, type PatchTaskBody, type PersonaConstraintOptions, type Preset, type PresetConfig, type PresetConstraints, type PreviewHidden, type PreviewMoment, type Profile, type ProfileActivity, type ProfileMemory, type ProfileTask, type ProtectionLevel, type ProtectionStatus, type Proxy, type ProxyKind, ROTATIONS, RUNTIME_STATES, type ReadyStatus, type Recording, type RecordingKind, type RecordingState, type RenderProgress, type RenderRequestBody, type RenderStage, type RevealCookiesBody, type RevealCookiesResult, type RevealedCookie, type Rotation, type RunActor, type RunOutcome, type RunStep, type RuntimeState, ScalebrowserClient, type ScalebrowserClientOptions, ScalebrowserError, type ScrollOptions, type SecretBindingMode, type SecretDeleteResult, type SecretKind, type SecretListResult, type SecretOrigin, type SecretPatchBody, type SecretRow, type SecretRunBody, type SecretRunMention, type SecretRunResult, type SecretScrubResult, type SecretState, type SessionExportBody, type SessionExportResult, type SessionImportBody, type SessionKind, type SetInterruptionLockBody, type SetInterruptionRuleBody, type ShareLinkLocal, type ShotFocus, type ShotIntent, type StepKind, type StepTarget, type StreamHandlers, type StreamParams, type StreamStatus, type TaskState, type TimestampState, type TranscriptWord, type TrustedInputBody, type TtsProviderView, type TtsVerifyResult, type UpdateGroupBody, type UpdateInboxBody, type UpdatePresetBody, VERSION, type Video, type VideoAccessGrant, type VideoAssetName, type VideoAssets, type VideoBackground, type VideoCard, type VideoDestination, type VideoFlags, type VideoPreset, type VideoPresetClip, type VideoPresetClipBody, type VideoPresetClipProgress, type VideoPresetClipStarted, type VideoPresetConfig, type VideoPresetPreview, type VideoPresetPreviewBody, type VideoState, type VideosPage, type VideosStorage, type WriteMemoryBody, deriveMetricsFromProfiles, errorMessage, eventStream, openCdpSession, parseSseFrame, subscribeEvents };
2829
+ export { type Account, type ActivitySnapshot, type AgentRun, ApiError, type ApiErrorBody, type ArtifactBytes, type ArtifactPutResult, type AttachOptions, type AudioStatus, type AuditDetectorReport, type AuditReport, type AuditStatus, type AuditVerdict, type BindInboxBody, type CdpConnectOptions, CdpError, type CdpEvent, CdpSession, type Chapter, type ClickOptions, type CodecsStatus, type Connection, type CreateGroupBody, type CreateInboxBody, type CreatePresetBody, type CreateTasksBody, type CreateTasksResult, DEFAULT_CAPACITY, type DeleteInterruptionRuleParams, type EffectiveInterruptionLock, ErrorCode, type ErrorCodeValue, type EvaluateOptions, type ExitClaim, type ExitRuleStatus, type ExitScope, type ExitStatus, type ExportPresetName, type ExtraOutput, type FetchLike, GEO_MODES, type GeoMode, type GoalSource, type Group, HOST_MODES, type HealthStatus, type HostMode, type Inbox, type InboxBinding, type InboxBindings, type InboxChannel, type InputClient, type InterruptionChoice, type InterruptionLock, type InterruptionLockRow, type InterruptionLockView, type InterruptionRuleRow, type LaunchHandle, type ListRunsParams, type ListStepsParams, type ListTasksParams, type ListVideosParams, type MediaAsset, type MediaKind, type MusicBed, type NarrationLine, type NavigateOptions, NetworkError, type OsFamily, type OutcomeSource, PROXY_KINDS, type PasskeyRow, type PatchTaskBody, type PersonaConstraintOptions, type Preset, type PresetConfig, type PresetConstraints, type PreviewHidden, type PreviewMoment, type Profile, type ProfileActivity, type ProfileMemory, type ProfileTask, type ProtectionLevel, type ProtectionStatus, type Proxy, type ProxyKind, type ProxyRow, type ProxyUsage, ROTATIONS, RUNTIME_STATES, type ReadyStatus, type Recording, type RecordingKind, type RecordingState, type RemoteStatus, type RenderProgress, type RenderRequestBody, type RenderStage, type RevealCookiesBody, type RevealCookiesResult, type RevealedCookie, type Rotation, type RunActor, type RunOutcome, type RunStep, type RuntimeState, ScalebrowserClient, type ScalebrowserClientOptions, ScalebrowserError, type ScrollOptions, type SecretBindingMode, type SecretDeleteResult, type SecretKind, type SecretListResult, type SecretOrigin, type SecretPatchBody, type SecretRow, type SecretRunBody, type SecretRunMention, type SecretRunResult, type SecretScrubResult, type SecretState, type SessionExportBody, type SessionExportResult, type SessionImportBody, type SessionKind, type SetInterruptionLockBody, type SetInterruptionRuleBody, type ShareLinkLocal, type ShotFocus, type ShotIntent, type StepKind, type StepTarget, type StreamHandlers, type StreamParams, type StreamStatus, type TaskState, type TimestampState, type TranscriptWord, type TrustedInputBody, type TtsProviderView, type TtsVerifyResult, type UpdateGroupBody, type UpdateInboxBody, type UpdatePresetBody, VERSION, type Video, type VideoAccessGrant, type VideoAssetName, type VideoAssets, type VideoBackground, type VideoCard, type VideoDestination, type VideoFlags, type VideoPreset, type VideoPresetClip, type VideoPresetClipBody, type VideoPresetClipProgress, type VideoPresetClipStarted, type VideoPresetConfig, type VideoPresetPreview, type VideoPresetPreviewBody, type VideoState, type VideosPage, type VideosStorage, type WriteMemoryBody, deriveMetricsFromProfiles, errorMessage, eventStream, openCdpSession, parseSseFrame, subscribeEvents };
package/dist/index.js CHANGED
@@ -288,6 +288,17 @@ var ControlApi = class extends ClientCore {
288
288
  throw err;
289
289
  }
290
290
  }
291
+ /**
292
+ * Which installation answered: its data directory and its binary.
293
+ *
294
+ * `health()` tells you something is there. This tells you WHAT, and the two are
295
+ * different questions whenever a machine holds more than one installation. The
296
+ * data directory is the identity; the address is not, because a port is a
297
+ * preference and a stale `runtime.json` can name one that moved.
298
+ */
299
+ getConnection(signal) {
300
+ return this.request("GET", "/v1/connection", void 0, { signal });
301
+ }
291
302
  /** "Is the daemon alive?" Public, needs no token. */
292
303
  health(signal) {
293
304
  return this.request("GET", "/health", void 0, { signal });
@@ -1518,6 +1529,7 @@ var ScalebrowserClient = class extends ClientCore {
1518
1529
  );
1519
1530
  }
1520
1531
  // ── Proxies (credentials write-only) ────────────────────────────────────────
1532
+ /** The list carries `used_by` per row; `getProxy` below does not. */
1521
1533
  listProxies(signal) {
1522
1534
  return this.request("GET", "/v1/proxies", void 0, { signal });
1523
1535
  }
@@ -1594,6 +1606,42 @@ var ScalebrowserClient = class extends ClientCore {
1594
1606
  throw err;
1595
1607
  }
1596
1608
  }
1609
+ // ── Remote access (the machine's own switch) ────────────────────────────────
1610
+ /**
1611
+ * Is remote access on for this machine?
1612
+ *
1613
+ * The switch is deliberately local: a chat service reaches this browser only
1614
+ * once somebody at the machine has turned it on. On a headless install there
1615
+ * is no UI to click, which is why it is here as well.
1616
+ */
1617
+ async getRemoteAccess(signal) {
1618
+ return this.request("GET", "/v1/remote", void 0, { signal });
1619
+ }
1620
+ /** Turn remote access on or off for this machine. */
1621
+ async setRemoteAccess(enabled, signal) {
1622
+ return this.request("PUT", "/v1/remote", { enabled }, { signal });
1623
+ }
1624
+ // ── Exit-address exclusivity (the machine's own switch) ─────────────────────
1625
+ /**
1626
+ * Does one exit address belong to one profile on this machine?
1627
+ *
1628
+ * Local like the remote-access switch above, and here for the same reason: on
1629
+ * a headless install there is no UI to click, and setting up fifty machines by
1630
+ * hand is not setting them up.
1631
+ */
1632
+ async getExitRule(signal) {
1633
+ return this.request("GET", "/v1/exit-rule", void 0, { signal });
1634
+ }
1635
+ /**
1636
+ * Turn the exit-address rule on or off for this machine.
1637
+ *
1638
+ * Off means two of your profiles can leave over the same address. Reach for it
1639
+ * when the provider hands out ONE address on purpose; a per-profile switch
1640
+ * exists for the narrower case (`updateProfile` with `exit_exclusive`).
1641
+ */
1642
+ async setExitRule(enabled, signal) {
1643
+ return this.request("PUT", "/v1/exit-rule", { enabled }, { signal });
1644
+ }
1597
1645
  // ── Events (SSE) ───────────────────────────────────────────────────────────
1598
1646
  /** Subscribe to lifecycle events. Returns an unsubscribe function. */
1599
1647
  subscribeEvents(handlers) {
@@ -1668,6 +1716,6 @@ var PROXY_KINDS = ["http", "socks5", "gateway"];
1668
1716
  var ROTATIONS = ["sticky", "rotating"];
1669
1717
 
1670
1718
  // src/index.ts
1671
- var VERSION = "0.5.0";
1719
+ var VERSION = "0.7.0";
1672
1720
 
1673
1721
  export { ApiError, CdpError, CdpSession, DEFAULT_CAPACITY, ErrorCode, GEO_MODES, HOST_MODES, NetworkError, PROXY_KINDS, ROTATIONS, RUNTIME_STATES, ScalebrowserClient, ScalebrowserError, VERSION, deriveMetricsFromProfiles, errorMessage, eventStream, openCdpSession, parseSseFrame, subscribeEvents };
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@scalebrowser/sdk",
3
- "version": "0.5.0",
3
+ "version": "0.7.0",
4
4
  "description": "Official Node/TypeScript SDK for the Scalebrowser daemon — typed REST client + direct-CDP driver plane (nodriver-style, not Playwright).",
5
5
  "type": "module",
6
6
  "license": "MIT",
7
7
  "homepage": "https://scalebrowser.net",
8
8
  "repository": {
9
9
  "type": "git",
10
- "url": "git+https://github.com/blackdiamond6390/scalebrowser.git",
10
+ "url": "git+https://github.com/blackdiamond-labs/scalebrowser.git",
11
11
  "directory": "sdks/node"
12
12
  },
13
13
  "bugs": {