@scalebrowser/sdk 0.6.0 → 0.8.0

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+The Node/TypeScript SDK for the Scalebrowser daemon.
+
+This file starts at 0.5.0, the oldest release still on npm when it was written
+(2026-09-09). What came before is in the repository's history. It was never
+published as release notes, and reconstructing it here would look like a record
+that had been kept all along.
+
+The daemon and the SDK version independently. An SDK release names the daemon
+version it was tested against wherever that matters.
+
+## 0.8.0 (2026-09-11)
+
+Breaking: `host_mode` is gone, and with it the `HostMode` type and the
+`HOST_MODES` list. It named one of two tiers, and there is only one left: a
+daemon runs the engine built for its own operating system, so the tier is the
+host. The field disappears from `Profile`, from `CreateProfileBody` and from a
+preset's `config`. A client that keeps sending it is not refused; the daemon
+ignores the key.
+
+## 0.7.0 (2026-09-09)
+
+- `checkProxy` and the exit-address views report the address KIND (mobile, fixed
+  line, datacenter, unknown) from an ASN dataset instead of the provider's own
+  description. The ownership term for an exit address follows that kind, so a
+  wrong classification used to be off by a factor of 30.
+- A proxy row carries a name and lists the profiles bound to it.
+- The exit-exclusivity rule has a switch, globally and per profile.
+
+## 0.6.0 (2026-09-01)
+
+- Remote access (the MCP tunnel) has a switch. It ships off, and it can only be
+  turned on at the machine itself.
+
+## 0.5.0 (2026-08-31)
+
+- Every profile carries a memory (`PROFILE.md`) and a task list. Both are
+  reachable through the client.
+- `proxy_short_side` in both SDKs.
+- The agent layer says "lease" throughout, matching the names of its tools.
+
+## What this file does not promise
+
+Nothing here promises a stable wire format. The daemon's REST surface is
+versioned under `/v1` and this client tracks it. A breaking change there arrives
+as a major version of the SDK, with the reason written in this file.

package/dist/index.cjs

@@ -294,6 +294,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 });
@@ -1375,6 +1386,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 });
   }
@@ -1524,6 +1552,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 });
   }
@@ -1615,6 +1644,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) {
@@ -1683,13 +1733,12 @@ 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";
 
 exports.ApiError = ApiError;
 exports.CdpError = CdpError;
@@ -1697,7 +1746,6 @@ exports.CdpSession = CdpSession;
 exports.DEFAULT_CAPACITY = DEFAULT_CAPACITY;
 exports.ErrorCode = ErrorCode;
 exports.GEO_MODES = GEO_MODES;
-exports.HOST_MODES = HOST_MODES;
 exports.NetworkError = NetworkError;
 exports.PROXY_KINDS = PROXY_KINDS;
 exports.ROTATIONS = ROTATIONS;