@martenhq/sdk 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 0.1.1
+
+- Task statuses are `todo`, `in_progress` and `done`: `needs_review` is gone from `TaskStatus` and the filters, as
+  it is from Marten.
+- `baseUrl` is documented as where the key goes: `MARTEN_API_URL` is read only when `baseUrl` is left out.
+- The README says what scopes do and don't limit (a key with `martens` asks your Martens, which act for you), that
+  `--scope` adds to the defaults, and which scopes groups' tasks need (`chats:read` to list, `chats:write` to add
+  or change).
+
+## 0.1.0
+
+- First release: `Marten` (`me`, `martens`, `chats`, `tasks`, `registry`, `revokeKey`), `MartenHandle` (`ask`,
+  `send`, `messages`) and `MartenError` (`status`, `code`, `retryAfter`).

package/README.md

@@ -20,13 +20,17 @@ Each has scopes:
 | Scope | Lets it |
 |---|---|
 | `martens` (default) | list your Martens, read and post in their 1:1s with you, `ask` them |
-| `tasks` (default) | list, add and change tasks in your chats |
+| `tasks` (default) | list, add and change tasks in your Martens' 1:1s (with `chats:read`, see groups' tasks too) |
 | `registry` (default) | browse the registry and install Martens for you |
-| `chats:read` | read your groups |
-| `chats:write` | post as you in your groups, add Martens to them |
+| `chats:read` | read your groups and their tasks |
+| `chats:write` | post as you in your groups, add or change tasks there, add Martens to them |
 
-`marten login` asks for the defaults; for the others, name them all: `npx @martenhq/cli login --scope martens --scope
-tasks --scope registry --scope chats:read --scope chats:write`.
+`marten login` gives the defaults; `--scope` adds to them (`npx @martenhq/cli login --scope chats:read --scope
+chats:write`), and signing in again keeps what the machine's key could already do.
+
+**Scopes limit what the key does, not what your Martens do.** A key with `martens` talks to your own Martens, and
+they act for you as they do when you ask them in the apps: they can read and post in the groups you share with them
+and use the apps you've connected for them. Give a key to a program you'd let ask your Marten things.
 
 A message sent with a key shows "via <key name>" under it, so everyone in the chat can tell.
 
@@ -87,7 +91,7 @@ seconds to wait) and `network`.
 ```ts
 new Marten({
   apiKey: "mk_live_…", // default: MARTEN_API_KEY
-  baseUrl: "https://api.marten.sh", // default: MARTEN_API_URL, else this
+  baseUrl: "https://api.marten.sh", // read from MARTEN_API_URL only when left out; then this
   fetch, // bring your own
 });
 ```

package/package.json

@@ -1,39 +1,31 @@
 {
   "name": "@martenhq/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Talk to your Martens from your own programs: ask them, read and post in your chats, manage tasks, install Martens.",
   "license": "MIT",
   "type": "module",
   "homepage": "https://marten.sh",
-  "repository": {
-  "type": "git",
-  "url": "git+https://github.com/RedPlanetHQ/marten-app.git",
-  "directory": "packages/sdk"
-},
-"keywords": ["marten", "agents", "ai", "sdk"],
-"engines": {
-"node": ">=20"
-},
-"sideEffects": false,
-"exports": {
-  ".": {
-    "types": "./dist/index.d.ts",
-    "default": "./dist/index.js"
+  "repository": { "type": "git", "url": "git+https://github.com/RedPlanetHQ/marten-app.git", "directory": "packages/sdk" },
+  "keywords": ["marten", "agents", "ai", "sdk"],
+  "engines": { "node": ">=20" },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
   },
-  "./package.json": "./package.json"
-},
-"main": "./dist/index.js",
-"types": "./dist/index.d.ts",
-"files": ["dist", "README.md", "LICENSE"],
-"publishConfig": {
-"access": "public"
-},
-"scripts": {
-  "build": "bun build.ts",
-  "test": "bun test",
-  "typecheck": "tsc -p tsconfig.json"
-},
-"devDependencies": {
-  "@types/bun": "^1.4.2"
-}
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": ["dist", "README.md", "CHANGELOG.md", "LICENSE"],
+  "publishConfig": { "access": "public" },
+  "scripts": {
+    "build": "bun build.ts",
+    "test": "bun test",
+    "typecheck": "tsc -p tsconfig.json"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.4.2"
+  }
 }