openmates 0.29.0-alpha.11 → 0.29.0-alpha.12

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 Only SDK-relevant compatibility notes are recorded here. Release versions follow
 the product line (`0.29.x` alpha prereleases from `dev`, stable from `main`).
 
+## 0.30.0
+
+### Breaking
+
+- **The SDK is API-key only and separate from the CLI login.** The root
+  `OpenMatesClient` export no longer loads the stored CLI login (the 0.29.x
+  `OPENMATES_SDK_CLI_SESSION` deprecation is complete). It is now the API-key
+  client: `new OpenMatesClient({ apiKey })`. Constructing it (or calling
+  `OpenMatesClient.load()`) without an `apiKey` throws
+  `OpenMatesApiKeyRequiredError` (code `OPENMATES_SDK_API_KEY_REQUIRED`), and the
+  `session` / `loadStoredSession` options are rejected. No SDK entrypoint reads
+  CLI state files or the keychain, so an SDK script can use a different account
+  from the logged-in CLI. `SDK_CLI_SESSION_DEPRECATION_CODE` is removed.
+
+  **Migration:** create an API key in Settings → Developers and pass it
+  explicitly (`new OpenMatesClient({ apiKey })` or `new OpenMates({ apiKey })`).
+  The key decrypts your chats locally with its own wrapped account key; nothing
+  else is needed. The `openmates` command line keeps its own login and is
+  unaffected.
+
+### Deprecated
+
+- `SessionClient.loginPassword()` / `importSession()` in `openmates/sdk/v1`. Public
+  SDKs are API-key only; these login modes are removed once every capability they
+  offer is available through API-key authentication (open work tracked in
+  `config/sdk-capabilities.json`).
+
 ## 0.29.x
 
 ### Deprecated

package/README.md

@@ -375,23 +375,37 @@ Use `chats.send()` for anonymous AI chat with automatic routing; `apps.ai.ask()`
 requires an account. With an API key, use `saveToAccount: true` when you want the
 chat saved to the OpenMates account.
 
-### Deprecated: implicit CLI login in the root `OpenMatesClient`
+### API keys only, never the CLI login
 
-`new OpenMatesClient()` / `OpenMatesClient.load()` from the root `openmates`
-export still load the stored CLI login when no `session` is passed, but this is
-deprecated: SDK credentials must be explicit. It emits one `DeprecationWarning`
-with code `OPENMATES_SDK_CLI_SESSION` per process. Pass `session` explicitly,
-set `loadStoredSession: false`, or use `SessionClient` from `openmates/sdk/v1`.
-A later minor release will require explicit credentials (see `CHANGELOG.md`).
-The `openmates` command line is unaffected.
+The SDK authenticates only with an API key you pass explicitly (or configure via
+`OPENMATES_API_KEY`). It is completely separate from the `openmates` command
+line: it never reads the CLI's `~/.openmates/session.json`, its state directory
+or the OS keychain, so a script can use a different account than the one logged
+in to the CLI. Create an API key in Settings → Developers. Each key carries its
+own wrapped copy of your account key, so the SDK decrypts your chats locally,
+in memory, with only that key.
+
+Since 0.30.0 the root `OpenMatesClient` is the API-key client and requires
+`apiKey`; constructing it without one throws `OpenMatesApiKeyRequiredError`
+(code `OPENMATES_SDK_API_KEY_REQUIRED`). The former `session` and
+`loadStoredSession` options are rejected.
+
+```typescript
+import { OpenMatesClient } from "openmates";
+
+const om = new OpenMatesClient({ apiKey: process.env.MY_OPENMATES_KEY! });
+```
 
 ### Native session SDK (preview)
 
 `openmates/sdk/v1` exports `SessionClient`, `RustApiKeyClient` and related
 types. Every operation runs in the shared OpenMates Rust core through a native
 Node-API module loaded from `native/<platform>-<arch>.node`; the SDK never
-launches the CLI and never reads CLI login state. Credentials are explicit:
-log in with `loginPassword()` or import a caller-owned session. If the native
+launches the CLI and never reads CLI login state. Its password/imported-session
+login modes (`loginPassword()`, `importSession()`) are deprecated: public SDKs
+are API-key only, and these modes are removed once every capability they offer
+is available through API-key authentication (tracked in
+`config/sdk-capabilities.json`). Use an API key for new integrations. If the native
 module for your platform is missing or incompatible, construction throws
 `SessionClientError` with code `native_binding_unavailable` (no TypeScript
 fallback). The SDK is moving to one portable WebAssembly build of the core

package/dist/chunk-3R7U773U.js

@@ -0,0 +1,46 @@
+import {
+  OpenMates,
+  OpenMatesConfigError
+} from "./chunk-APUIUJ63.js";
+
+// src/sdkRootClient.ts
+var SDK_API_KEY_REQUIRED_CODE = "OPENMATES_SDK_API_KEY_REQUIRED";
+var OpenMatesApiKeyRequiredError = class extends OpenMatesConfigError {
+  code = SDK_API_KEY_REQUIRED_CODE;
+  constructor(message) {
+    super(message);
+    this.name = "OpenMatesApiKeyRequiredError";
+  }
+};
+var ALLOWED_OPTIONS = /* @__PURE__ */ new Set(["apiKey", "apiUrl", "deviceId", "deviceIdPath"]);
+var MIGRATION = "Create an API key in Settings \u2192 Developers and pass it explicitly: new OpenMatesClient({ apiKey }). The SDK never uses the CLI login.";
+function requireApiKeyOptions(options) {
+  if (options === void 0 || options === null || typeof options !== "object" || Array.isArray(options)) {
+    throw new OpenMatesApiKeyRequiredError(`OpenMatesClient requires an explicit API key. ${MIGRATION}`);
+  }
+  const record = options;
+  for (const key of Object.keys(record)) {
+    if (key === "session" || key === "loadStoredSession") {
+      throw new OpenMatesApiKeyRequiredError(`OpenMatesClient no longer accepts \`${key}\`; CLI sessions are not SDK credentials. ${MIGRATION}`);
+    }
+    if (!ALLOWED_OPTIONS.has(key)) throw new OpenMatesConfigError(`Unknown OpenMatesClient option: ${key}`);
+  }
+  if (typeof record.apiKey !== "string" || record.apiKey.trim() === "") {
+    throw new OpenMatesApiKeyRequiredError(`OpenMatesClient requires an explicit API key. ${MIGRATION}`);
+  }
+  return { ...record, anonymous: false, sdkName: "npm" };
+}
+var OpenMatesClient = class _OpenMatesClient extends OpenMates {
+  constructor(options) {
+    super(requireApiKeyOptions(options));
+  }
+  static load(options) {
+    return new _OpenMatesClient(options);
+  }
+};
+
+export {
+  SDK_API_KEY_REQUIRED_CODE,
+  OpenMatesApiKeyRequiredError,
+  OpenMatesClient
+};