@scalebrowser/sdk 0.6.0 → 0.8.0

package/dist/index.d.ts

@@ -81,7 +81,6 @@ interface PersonaMisc {
     get_installed_related_apps: boolean;
     max_touch_points: number;
     pdf_viewer_enabled: boolean;
-    headless_guards: boolean;
 }
 interface Persona {
     os: OsFamily;
@@ -111,7 +110,7 @@ type RecordingState = 'recording' | 'finishing' | 'finished' | 'failed';
 type VideoState = 'queued' | 'rendering' | 'done' | 'failed' | 'cancelled';
 type ExportPresetName = 'web' | 'social' | '4k' | 'editing' | 'gif';
 type AudioStatus = 'ok' | 'silent' | 'off' | 'failed';
-type RenderStage = 'planning' | 'narration' | 'compositing' | 'encoding' | 'finishing';
+type RenderStage = 'planning' | 'narration' | 'compositing' | 'encoding' | 'finishing' | 'extras';
 /** Which files a finished video has. Booleans on purpose, never paths. */
 interface VideoAssets {
     video: boolean;
@@ -159,10 +158,11 @@ type TimestampState = {
     state: 'failed';
     reason: string;
 };
+/** One spoken word and when it is heard in the finished video, in milliseconds from its start. */
 interface TranscriptWord {
     text: string;
-    from_ms: number;
-    to_ms: number;
+    start_ms: number;
+    end_ms: number;
 }
 /** One video row: queued and rendering renders included. */
 interface Video {
@@ -177,7 +177,7 @@ interface Video {
     kind: RecordingKind;
     preset_name: string;
     /** The resolved recipe this video renders (or rendered) under. */
-    preset: unknown;
+    preset: VideoPresetConfig;
     export: ExportPresetName;
     assets: VideoAssets;
     duration_ms: number | null;
@@ -190,7 +190,8 @@ interface Video {
     chapters: Chapter[];
     transcript: TranscriptWord[] | null;
     flags: VideoFlags | null;
-    share: unknown | null;
+    /** The share link of this video ON THIS MACHINE, or nothing shared yet. */
+    share: ShareLinkLocal | null;
     error: string | null;
     created_at: number;
     updated_at: number;
@@ -204,8 +205,11 @@ interface Recording {
     kind: RecordingKind;
     state: RecordingState;
     title: string | null;
+    /** The id of the stored preset the recording was made under, `null` when it named none. */
     preset_id: string | null;
-    preset: unknown;
+    /** That preset's name as it read when the recording started. */
+    preset_name: string | null;
+    preset: VideoPresetConfig;
     manifest_version: number;
     css_width: number;
     css_height: number;
@@ -299,10 +303,14 @@ interface VideoAccessGrant {
 interface VideosStorage {
     recordings_bytes: number;
     videos_bytes: number;
+    /** The main files of the videos this machine still shares. */
     link_bytes: number;
-    link_limit: number;
-    uploads_today: number;
-    uploads_limit: number;
+    /** Known only to the control plane; `null` here. */
+    link_limit: number | null;
+    /** Known only to the control plane; `null` here. */
+    uploads_today: number | null;
+    /** Known only to the control plane; `null` here. */
+    uploads_limit: number | null;
     capacity: {
         recordings_active: number;
         recordings_max: number;
@@ -322,6 +330,18 @@ interface CodecsStatus {
     };
     /** Hardware encoders that passed a real test encode, in preference order. */
     hardware: string[];
+    /** Whether the hardware probe has run. Before it, an empty `hardware` means
+     *  "not asked yet", not "none". */
+    probed: boolean;
+    /** Exports this daemon refuses whatever the order says, with the reason. An
+     *  editor hides them rather than letting a render fail on them. */
+    exports_blocked: BlockedExport[];
+}
+/** One export the daemon refuses, e.g. `4k` while a 3840-wide capture is not
+ *  offered. `reason` starts with its snake code. */
+interface BlockedExport {
+    export: ExportPresetName;
+    reason: string;
 }
 /** What kind of file a media asset is. */
 type MediaKind = 'image' | 'music' | 'subtitle_style';
@@ -380,16 +400,23 @@ interface ShareLinkLocal {
     updated_at: number;
     error: string | null;
 }
+/** `GET /v1/videos/:id/share`: the order, and the link's access code when this
+ *  machine keeps one (sealed at rest). A link the daemon makes for a preset with
+ *  `export.destination.passcode` gets a generated code of ten characters, and
+ *  this is where its owner reads it. `Video.share`, `video_changed` and the
+ *  `video` tool never carry the code. */
+interface ShareStatus extends ShareLinkLocal {
+    /** Absent when this machine keeps no code: the link has none, or its
+     *  revocation is ordered. */
+    code?: string;
+}
 
 /**
- * Wire types: a 1:1 mirror of the daemon's serialized domain model
- * (`crates/core/src/model.rs`, `persona.rs`, `events.rs`) and the endpoint
- * contract in `docs/features/api.md`. Mirrored against `web-ui/src/api/types/`
- * (a directory of split files behind the `web-ui/src/api/types.ts` barrel), and
- * that mirror is ENFORCED: `web-ui/src/test/sdk-type-mirror.test.ts` compares
- * every shared exported declaration and goes red on drift. The Python SDK
- * (`sdks/python/src/scalebrowser/models*.py`) carries the same shapes by hand,
- * deliberately without a gate; a TS↔pydantic comparator is its own tool.
+ * Wire types: a 1:1 mirror of the daemon's serialized domain model and of the
+ * endpoint contract, and the one source of both on the TypeScript side.
+ *
+ * These files import nothing but each other, which keeps them usable inside a
+ * browser bundle.
  *
  * All Rust enums serialize `snake_case` (serde `rename_all`). Timestamps are
  * unix seconds (`number`, Rust `i64`). The truth for any disagreement is the
@@ -399,9 +426,6 @@ interface ShareLinkLocal {
 /** `RuntimeState` (AC-PR-004). */
 type RuntimeState = 'stopped' | 'starting' | 'running' | 'crashed';
 declare const RUNTIME_STATES: readonly RuntimeState[];
-/** `HostMode` (PRD §B, DEC-004). Default `linux_engine_spoof`. */
-type HostMode = 'linux_engine_spoof' | 'local_native_windows';
-declare const HOST_MODES: readonly HostMode[];
 /** `GeoMode` (AC-PX-002). Default `follow_exit`. */
 type GeoMode = 'strict_expected' | 'follow_exit' | 'off';
 declare const GEO_MODES: readonly GeoMode[];
@@ -436,12 +460,21 @@ interface Profile {
     seed: string;
     engine_version: string;
     persona: Persona;
-    host_mode: HostMode;
     gpu_persona: string | null;
     group_id: string | null;
     proxy_id: string | null;
     geo_mode: GeoMode;
     expected_country: string | null;
+    /**
+     * Whether this profile claims its exit address for itself, so no other profile of
+     * the account starts on it (DEC-017). On for a new profile. Turn it off for a
+     * provider that hands out ONE address on purpose, a residential line you pay for
+     * or a whitelisted office address, where the rule would refuse every start after
+     * the first.
+     *
+     * Additive: a daemon predating it omits the field.
+     */
+    exit_exclusive?: boolean;
     data_dir: string;
     created_at: number;
     last_open_at: number | null;
@@ -468,7 +501,6 @@ interface Group {
 interface PresetConfig {
     /** Pin the batch to one engine build. Omit for per-profile version diversity. */
     engine_version?: string | null;
-    host_mode?: HostMode | null;
     geo_mode?: GeoMode | null;
     /** The geo GATE's expectation, not the persona's drawn region. */
     expected_country?: string | null;
@@ -586,7 +618,8 @@ interface VideoPresetConfig {
         voice: string | null;
         language: string;
         subtitles: 'burned' | 'file' | 'off';
-        subtitle_style: string;
+        /** `custom:<media_id>` names an uploaded font (media kind `subtitle_style`). */
+        subtitle_style: 'classic' | 'word' | `custom:${string}`;
         page_audio: boolean;
         music: MusicBed | null;
     };
@@ -718,12 +751,54 @@ interface Proxy {
     host: string;
     port: number;
     rotation: Rotation;
+    /**
+     * The operator's own name for this row, or `null` if they never gave one.
+     *
+     * The only field that tells two rows of one provider pool apart: kind, host,
+     * port and rotation are identical across a bought gateway, and the session tag
+     * that actually differs sits in the write-only username. Do not fall back to
+     * `last_exit_ip` for identity; the health check wrote it hours or days ago and
+     * a rotating exit no longer has that address.
+     */
+    label: string | null;
     last_exit_ip: string | null;
     last_country: string | null;
+    /**
+     * The operator string the geo probe answered with, for example
+     * `"AS21928 T-Mobile USA, Inc."`. Part of the same measurement as the fields
+     * around it: one check writes them, an endpoint change clears them together.
+     * The daemon derives the address kind from it, which decides how long an
+     * address stays reserved for a profile.
+     */
+    last_asn: string | null;
     last_check_at: number | null;
     healthy: boolean | null;
+    /** Round-trip latency of the last health check, in ms. */
+    last_latency_ms: number | null;
+    /**
+     * The row holds credentials that could not be decrypted (a database restored
+     * without its master key). Every launch through it fails closed, so a screen
+     * that shows only `healthy` paints such a row green while nothing can use it.
+     * Omitted by the daemon when false.
+     */
+    credentials_unreadable?: boolean;
     created_at: number;
 }
+/**
+ * Who depends on one proxy, as `GET /v1/proxies` reports it per row.
+ *
+ * `count` is exact, `names` holds at most three. A proxy shared by a fleet must
+ * not drag every profile name into the listing, so showing the names without the
+ * count would turn "three of forty" into "these three".
+ */
+interface ProxyUsage {
+    count: number;
+    names: string[];
+}
+/** A row of the proxy LIST: the proxy plus who uses it. The single GET has no `used_by`. */
+interface ProxyRow extends Proxy {
+    used_by: ProxyUsage;
+}
 /** Per-detector outcome; `skip` means the page could not be evaluated, NOT a pass. */
 type AuditVerdict = 'pass' | 'warn' | 'fail' | 'skip' | 'error';
 interface AuditDetectorReport {
@@ -780,8 +855,9 @@ interface SessionImportBody {
 }
 /**
  * Trusted-input payload (`POST /v1/profiles/:id/input`, G8, AC-API-003). Only
- * `action` and `humanize` are fixed by `docs/features/api.md`; the per-action coordinate
- * fields below are the SDK's contract assumption for the daemon's input crate.
+ * `action` and `humanize` are fixed by the API contract; the per-action
+ * coordinate fields below are the SDK's assumption about the daemon's input
+ * layer.
  */
 type TrustedInputBody = {
     action: 'move';
@@ -889,7 +965,7 @@ interface ExitStatus {
 /**
  * The per-profile task list and the profile's own durable memory.
  *
- * Mirrors `web-ui/src/api/types/tasks.ts`, the shared source of contract truth.
+ * One of the files that are the daemon's wire contract.
  */
 /**
  * Where a task stands.
@@ -1168,13 +1244,6 @@ type StreamedEvent = LifecycleEvent & {
  * the browser `EventSource` cannot do that) and reconnect with backoff. A
  * `/v1/ws` websocket carries the same events; SSE is sufficient for one-way
  * fan-out.
- *
- * Mirrors `web-ui/src/api/events.ts` line for line, deliberately: this package
- * ships to npm and should carry no dependency it does not need, so a shared
- * package would cost more than the copy does. The copy pays for itself with a
- * gate instead: `scripts/verify-mirrored-values.mjs` holds `MAX_BACKOFF_MS` and
- * the backoff line itself against the other side. Two clients of the same daemon
- * that come back at different speeds would be a decision nobody made.
  */
 
 /** Injectable `fetch`; defaults to the global at call time. */
@@ -1218,8 +1287,7 @@ declare function eventStream(params: StreamParams): AsyncIterableIterator<Lifecy
  * What the browser asks (interruptions), the bytes that go in and out
  * (artifacts), and what the licence says (account).
  *
- * Interruption shapes mirror `web-ui/src/api/types/credentials.ts`, the shared
- * source of contract truth.
+ * One of the files that are the daemon's wire contract.
  */
 /** What an operator has taken out of an agent's hands. */
 type InterruptionLock = 'always_block' | 'always_allow' | 'agent_decides';
@@ -1291,6 +1359,32 @@ interface ArtifactBytes {
     /** Parsed out of `Content-Disposition`, when the daemon sent one. */
     filename: string | null;
 }
+/**
+ * Which installation this daemon is: the data directory it serves and the binary
+ * it runs from.
+ *
+ * One machine can hold several installations, and they are told apart by their
+ * data directory, never by their address. A port is a preference: the desktop app
+ * takes the first free one from 8787, and a `runtime.json` left behind by an
+ * earlier daemon can name a port that something else now holds. Ask this before
+ * assuming the daemon you reached is the one you meant.
+ */
+interface Connection {
+    /** The address the native API is bound to, as resolved. */
+    native_addr: string;
+    /** The data directory, in a form suitable for showing or for a command line. */
+    data_dir: string;
+    /**
+     * The same directory, in the form two daemons compare. Case is folded on
+     * Windows and links are resolved, so do not show this one to anybody; compare
+     * it with another daemon's value and nothing else.
+     */
+    data_dir_key: string;
+    /** Absolute path of the running binary, for a client that launches it over stdio. */
+    executable?: string;
+    /** The AdsPower-compatible adapter's address, when that adapter is enabled. */
+    adspower_addr?: string;
+}
 /**
  * Licence state, for display.
  *
@@ -1344,6 +1438,27 @@ interface RemoteStatus {
      *  whatever the switch says. */
     ready: boolean;
 }
+/**
+ * What `GET /v1/exit-rule` answers: the machine's own exit-address exclusivity
+ * switch.
+ *
+ * On by default. Turn it off for a provider that hands out ONE address on
+ * purpose, a residential line you pay for or a whitelisted office address, where
+ * the rule would refuse every start after the first.
+ */
+interface ExitRuleStatus {
+    /** Does the rule apply on this machine? */
+    enabled: boolean;
+    /** Did a person decide this, or is the configured default still standing? */
+    explicit: boolean;
+    /**
+     * How many profiles switched the rule off for themselves.
+     *
+     * A global "on" reads as "every profile is separated", and that stops being
+     * true the moment one profile has its own switch off.
+     */
+    profiles_opted_out: number;
+}
 
 interface ScalebrowserClientOptions {
     /** Daemon base URL. Default `http://127.0.0.1:8787`. */
@@ -1411,6 +1526,15 @@ declare class ControlApi extends ClientCore {
      * connected or permitted. Same shape of tolerance as {@link getMetrics}.
      */
     getAccount(signal?: AbortSignal): Promise<Account>;
+    /**
+     * Which installation answered: its data directory and its binary.
+     *
+     * `health()` tells you something is there. This tells you WHAT, and the two are
+     * different questions whenever a machine holds more than one installation. The
+     * data directory is the identity; the address is not, because a port is a
+     * preference and a stale `runtime.json` can name one that moved.
+     */
+    getConnection(signal?: AbortSignal): Promise<Connection>;
     /** "Is the daemon alive?" Public, needs no token. */
     health(signal?: AbortSignal): Promise<HealthStatus>;
     /** "Can it serve?" Local facts only; the control plane is deliberately not consulted. */
@@ -1426,6 +1550,24 @@ interface ProfileIdsResult {
     count: number;
     ids: string[];
 }
+/**
+ * `GET /v1/profiles/count`: how many profiles match, split by runtime state.
+ *
+ * `total` counts ROWS, so it is the sum of the four states for every state this
+ * daemon can read; a row in a state a newer build introduced counts in `total`
+ * alone rather than being folded into `stopped`.
+ *
+ * The `state` filter is the one this route ignores. A caller labelling all four
+ * scopes is sitting in one of them, so narrowing by it would answer the other
+ * three with zero. Every other filter binds exactly as it does for the listing.
+ */
+interface ProfileCounts {
+    total: number;
+    stopped: number;
+    starting: number;
+    running: number;
+    crashed: number;
+}
 /** `POST /v1/bulk/start`: per-id results plus what the batch as a whole did. */
 interface BulkStartResult {
     results: {
@@ -1450,18 +1592,39 @@ interface ListProfilesParams {
 interface CreateProfileBody {
     name: string;
     seed?: string;
-    host_mode?: HostMode;
     geo_mode?: GeoMode;
     expected_country?: string | null;
+    /**
+     * Draw the identity for this region (ISO-3166 alpha-2, e.g. `"DE"`): language,
+     * timezone and speech voices come out of one row of the model together. Omit to
+     * draw unconstrained, weighted the way the population is.
+     *
+     * This is not `expected_country`, which only checks the exit and never touches
+     * the identity. And it is a starting value, not a promise: under the default
+     * `geo_mode` the launch rewrites the region to the country the profile really
+     * exits in, which is its proxy's, or with no proxy the machine's own. The
+     * daemon refuses the pairings where that collision is already known.
+     *
+     * Set only at create. A region the model cannot draw is a 400 listing the ones
+     * it can.
+     */
+    persona_country?: string;
     group_id?: string | null;
     proxy_id?: string | null;
 }
 /**
- * PATCH, all mutable fields optional. `host_mode` and `seed` are fixed at create
- * time (C4/C5): a DIFFERING `host_mode` is refused with 400, an unchanged echo is
- * accepted. Changing a tier requires delete + recreate.
+ * PATCH, all mutable fields optional. `seed` and `persona_country` are fixed at
+ * create time (C5): they draw the identity, and redrawing it under a profile that
+ * has already been used would be a new identity in an old profile's clothes.
  */
-type UpdateProfileBody = Omit<Partial<CreateProfileBody>, "host_mode" | "seed">;
+type UpdateProfileBody = Omit<Partial<CreateProfileBody>, "seed" | "persona_country"> & {
+    /**
+     * Turn the exit-address rule off for this profile (DEC-017). Deliberately not
+     * part of `CreateProfileBody`: a new profile always claims its address, and
+     * switching that off is a later, deliberate act for a setup that needs it.
+     */
+    exit_exclusive?: boolean;
+};
 interface StartProfileBody {
     headless?: boolean;
 }
@@ -1510,6 +1673,12 @@ interface CreateProxyBody {
     username?: string | null;
     password?: string | null;
     rotation?: Rotation;
+    /**
+     * The operator's own name for the row. Trimmed by the daemon; a blank string is
+     * stored as null. On an update the field carries three states: omit the key to
+     * leave the name alone, send `null` to clear it, send a string to set it.
+     */
+    label?: string | null;
 }
 type UpdateProxyBody = Partial<CreateProxyBody>;
 /**
@@ -1646,9 +1815,9 @@ declare class ExtensionsApi extends ClientCore {
  * The account layer: mailboxes, passkeys and the one door a cookie value leaves
  * through.
  *
- * Mailbox and passkey shapes mirror `web-ui/src/api/types/{inboxes,credentials}.ts`,
- * the shared source of contract truth. The cookie reveal has no UI counterpart:
- * it is a REST-only route deliberately kept off every screen.
+ * One of the files that are the daemon's wire contract. The cookie
+ * reveal has no UI counterpart: it is a REST-only route deliberately kept off
+ * every screen.
  */
 /** One configured mailbox. The password is never sent back. */
 interface Inbox {
@@ -2051,7 +2220,7 @@ declare class TasksApi extends ClientCore {
  * the live event stream carries them, and the run list describes the same rows.
  * A second copy would let the two drift apart while both looked right.
  *
- * Mirrors `web-ui/src/api/types/runs.ts`, the shared source of contract truth.
+ * One of the files that are the daemon's wire contract.
  */
 
 /** Who made the outcome claim. `derived` means nobody did. */
@@ -2171,7 +2340,7 @@ declare class VideosApi extends ClientCore {
      *  whether the link still lives is read from the control plane, not from
      *  here: a number carried along would be wrong the moment another machine
      *  revoked. */
-    shareStatus(videoId: string, signal?: AbortSignal): Promise<ShareLinkLocal>;
+    shareStatus(videoId: string, signal?: AbortSignal): Promise<ShareStatus>;
     /** Revoke the link. The files fall at once; the order stays until the control
      *  plane confirms. */
     revokeShare(videoId: string, signal?: AbortSignal): Promise<void>;
@@ -2403,7 +2572,7 @@ interface Metrics {
  * (shapes), nowhere else.
  */
 
-/** Mirrors `CapacityConfig::default()` (`crates/core/src/config.rs`). */
+/** The daemon's own default capacity limits. */
 declare const DEFAULT_CAPACITY: {
     max_concurrent: number;
     ram_budget_mb: number;
@@ -2431,6 +2600,18 @@ declare class ScalebrowserClient extends ClientCore {
      * page you fetched. Asking for ids costs one request and no persona payloads.
      */
     listProfileIds(params?: ListProfilesParams, signal?: AbortSignal): Promise<ProfileIdsResult>;
+    /**
+     * How many profiles match `params`, split by runtime state. One request, and
+     * its size does not grow with the fleet.
+     *
+     * `listProfiles` is paged and answers a bare array, so counting what came back
+     * counts the page. `listProfileIds` carries the same total but ships an
+     * identifier per profile to do it, and cannot split by state at all.
+     *
+     * `params.state` is ignored here on purpose: a caller labelling every state is
+     * sitting in one of them.
+     */
+    countProfiles(params?: ListProfilesParams, signal?: AbortSignal): Promise<ProfileCounts>;
     getProfile(id: string, signal?: AbortSignal): Promise<Profile>;
     createProfile(body: CreateProfileBody): Promise<Profile>;
     updateProfile(id: string, body: UpdateProfileBody): Promise<Profile>;
@@ -2511,7 +2692,8 @@ declare class ScalebrowserClient extends ClientCore {
      * drifts the moment that model changes and every create 400s.
      */
     getPersonaConstraints(signal?: AbortSignal): Promise<PersonaConstraintOptions>;
-    listProxies(signal?: AbortSignal): Promise<Proxy[]>;
+    /** The list carries `used_by` per row; `getProxy` below does not. */
+    listProxies(signal?: AbortSignal): Promise<ProxyRow[]>;
     getProxy(id: string, signal?: AbortSignal): Promise<Proxy>;
     createProxy(body: CreateProxyBody): Promise<Proxy>;
     updateProxy(id: string, body: UpdateProxyBody): Promise<Proxy>;
@@ -2549,6 +2731,22 @@ declare class ScalebrowserClient extends ClientCore {
     getRemoteAccess(signal?: AbortSignal): Promise<RemoteStatus>;
     /** Turn remote access on or off for this machine. */
     setRemoteAccess(enabled: boolean, signal?: AbortSignal): Promise<RemoteStatus>;
+    /**
+     * Does one exit address belong to one profile on this machine?
+     *
+     * Local like the remote-access switch above, and here for the same reason: on
+     * a headless install there is no UI to click, and setting up fifty machines by
+     * hand is not setting them up.
+     */
+    getExitRule(signal?: AbortSignal): Promise<ExitRuleStatus>;
+    /**
+     * Turn the exit-address rule on or off for this machine.
+     *
+     * Off means two of your profiles can leave over the same address. Reach for it
+     * when the provider hands out ONE address on purpose; a per-profile switch
+     * exists for the narrower case (`updateProfile` with `exit_exclusive`).
+     */
+    setExitRule(enabled: boolean, signal?: AbortSignal): Promise<ExitRuleStatus>;
     /** Subscribe to lifecycle events. Returns an unsubscribe function. */
     subscribeEvents(handlers: StreamHandlers): () => void;
     /** `for await (const event of client.events())` over lifecycle events. */
@@ -2568,8 +2766,8 @@ interface ScalebrowserClient extends IdentityApi, RunsApi, VideosApi, ControlApi
 }
 
 /**
- * Error model: stable numeric API error codes (SPEC §5,
- * `crates/core/src/error.rs`) and the typed exceptions the SDK throws.
+ * Error model: the stable numeric API error codes and the typed exceptions
+ * the SDK throws.
  */
 /** Stable numeric API error codes (4001–4013, append-only: a retired code stays
  * reserved rather than being reused). */
@@ -2606,7 +2804,7 @@ declare const ErrorCode: {
     readonly ExitAddressTaken: 4013;
 };
 type ErrorCodeValue = (typeof ErrorCode)[keyof typeof ErrorCode];
-/** Error body shape: `{ code, message }` (docs/features/api.md). */
+/** Error body shape: `{ code, message }`. */
 interface ApiErrorBody {
     code?: number;
     message?: string;
@@ -2661,6 +2859,6 @@ declare function errorMessage(err: unknown): string;
  * ```
  */
 
-declare const VERSION = "0.6.0";
+declare const VERSION = "0.8.0";
 
-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 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 };
+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 BlockedExport, 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, type HealthStatus, 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 ShareStatus, 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

@@ -288,6 +288,17 @@ var ControlApi = class extends ClientCore {
       throw err;
     }
   }
+  /**
+   * Which installation answered: its data directory and its binary.
+   *
+   * `health()` tells you something is there. This tells you WHAT, and the two are
+   * different questions whenever a machine holds more than one installation. The
+   * data directory is the identity; the address is not, because a port is a
+   * preference and a stale `runtime.json` can name one that moved.
+   */
+  getConnection(signal) {
+    return this.request("GET", "/v1/connection", void 0, { signal });
+  }
   /** "Is the daemon alive?" Public, needs no token. */
   health(signal) {
     return this.request("GET", "/health", void 0, { signal });
@@ -1369,6 +1380,23 @@ var ScalebrowserClient = class extends ClientCore {
       signal
     });
   }
+  /**
+   * How many profiles match `params`, split by runtime state. One request, and
+   * its size does not grow with the fleet.
+   *
+   * `listProfiles` is paged and answers a bare array, so counting what came back
+   * counts the page. `listProfileIds` carries the same total but ships an
+   * identifier per profile to do it, and cannot split by state at all.
+   *
+   * `params.state` is ignored here on purpose: a caller labelling every state is
+   * sitting in one of them.
+   */
+  countProfiles(params = {}, signal) {
+    return this.request("GET", "/v1/profiles/count", void 0, {
+      query: { group: params.group, q: params.q },
+      signal
+    });
+  }
   getProfile(id, signal) {
     return this.request("GET", `/v1/profiles/${enc(id)}`, void 0, { signal });
   }
@@ -1518,6 +1546,7 @@ var ScalebrowserClient = class extends ClientCore {
     );
   }
   // ── Proxies (credentials write-only) ────────────────────────────────────────
+  /** The list carries `used_by` per row; `getProxy` below does not. */
   listProxies(signal) {
     return this.request("GET", "/v1/proxies", void 0, { signal });
   }
@@ -1609,6 +1638,27 @@ var ScalebrowserClient = class extends ClientCore {
   async setRemoteAccess(enabled, signal) {
     return this.request("PUT", "/v1/remote", { enabled }, { signal });
   }
+  // ── Exit-address exclusivity (the machine's own switch) ─────────────────────
+  /**
+   * Does one exit address belong to one profile on this machine?
+   *
+   * Local like the remote-access switch above, and here for the same reason: on
+   * a headless install there is no UI to click, and setting up fifty machines by
+   * hand is not setting them up.
+   */
+  async getExitRule(signal) {
+    return this.request("GET", "/v1/exit-rule", void 0, { signal });
+  }
+  /**
+   * Turn the exit-address rule on or off for this machine.
+   *
+   * Off means two of your profiles can leave over the same address. Reach for it
+   * when the provider hands out ONE address on purpose; a per-profile switch
+   * exists for the narrower case (`updateProfile` with `exit_exclusive`).
+   */
+  async setExitRule(enabled, signal) {
+    return this.request("PUT", "/v1/exit-rule", { enabled }, { signal });
+  }
   // ── Events (SSE) ───────────────────────────────────────────────────────────
   /** Subscribe to lifecycle events. Returns an unsubscribe function. */
   subscribeEvents(handlers) {
@@ -1677,12 +1727,11 @@ applyMixins(ScalebrowserClient, [
 
 // src/types.ts
 var RUNTIME_STATES = ["stopped", "starting", "running", "crashed"];
-var HOST_MODES = ["linux_engine_spoof", "local_native_windows"];
 var GEO_MODES = ["strict_expected", "follow_exit", "off"];
 var PROXY_KINDS = ["http", "socks5", "gateway"];
 var ROTATIONS = ["sticky", "rotating"];
 
 // src/index.ts
-var VERSION = "0.6.0";
+var VERSION = "0.8.0";
 
-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 };
+export { ApiError, CdpError, CdpSession, DEFAULT_CAPACITY, ErrorCode, GEO_MODES, NetworkError, PROXY_KINDS, ROTATIONS, RUNTIME_STATES, ScalebrowserClient, ScalebrowserError, VERSION, deriveMetricsFromProfiles, errorMessage, eventStream, openCdpSession, parseSseFrame, subscribeEvents };