@butlerbot/sdk 0.0.18 → 0.0.20

package/dist/config.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CONFIG = void 0;
 exports.CONFIG = {
-    server: "https://core.butlerbot.net",
+    server: "https://core.butler.now",
     healthcheckPath: "/api/healthcheck",
     paths: {
         conversation: {

package/dist/link/link.js

@@ -379,9 +379,20 @@ class Link {
         }
         const controller = new AbortController();
         this.calls.set(callId, controller);
+        // Only a final status is kept in the conversation, so every call has to end on
+        // one. The tool may send its own, with a better label than we could invent; if
+        // it does not, we send one for it below rather than leave the call unfinished.
+        let reported = "running";
+        const report = (label, state) => {
+            if (reported !== "running")
+                return;
+            reported = state;
+            this.send("tool.status", { label, state }, frame.id);
+        };
         const status = {
-            update: (label) => this.send("tool.status", { label, state: "running" }, frame.id),
-            fail: (label) => this.send("tool.status", { label, state: "failed" }, frame.id),
+            update: (label) => report(label, "running"),
+            complete: (label) => report(label, "completed"),
+            fail: (label) => report(label, "failed"),
         };
         void tool.invoke(args, meta, status, controller.signal).then(result => {
             this.calls.delete(callId);
@@ -389,6 +400,15 @@ class Link {
             // given up on the call, so there is nothing to report to.
             if (!this.socket)
                 return;
+            if (!result.ok && reported === "completed") {
+                // The tool said it succeeded and then failed anyway. The outcome is the
+                // part worth keeping, so let the failure replace what it claimed.
+                reported = "running";
+            }
+            if (result.ok)
+                report(`Finished ${tool.id}.`, "completed");
+            else
+                report(result.error, "failed");
             this.send("tool.result", result.ok
                 ? { ok: true, output: result.output }
                 : { ok: false, error: result.error }, frame.id);

package/dist/link/tool.d.ts

@@ -1,9 +1,19 @@
 import { LinkToolDescriptor } from "./protocol";
 import { InferSchemaOutput, JSONSchema, ToolSchema } from "./schema";
-/** Reports progress while a tool runs. Shown live in Alfred's tool status feed. */
+/**
+ * Reports progress while a tool runs. Shown live in Alfred's tool status feed.
+ *
+ * `update` is progress; `complete` and `fail` are final. Only a final status is kept
+ * in the conversation once the turn ends — a status left at `update` is shown live
+ * and then forgotten — so a tool that wants to leave a trace should finish with
+ * `complete`. If it does not, the link sends a final status for it when `run`
+ * returns, so the call is recorded either way.
+ */
 export type ToolStatusReporter = {
-    /** Replaces the current status label. */
+    /** Replaces the current status label. The call is still running. */
     update(label: string): void;
+    /** Marks the tool as finished, with the label the conversation keeps. */
+    complete(label: string): void;
     /** Marks the tool as failed in the UI. The thrown error still decides the result. */
     fail(label: string): void;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@butlerbot/sdk",
-	"version": "0.0.18",
+	"version": "0.0.20",
 	"description": "The official ButlerBot SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -35,7 +35,7 @@
 	"bugs": {
 		"url": "https://github.com/butlerbots/alfred5_sdk/issues"
 	},
-	"homepage": "https://butlerbot.net",
+	"homepage": "https://butler.now",
 	"engines": {
 		"node": ">=18.0.0"
 	},

package/readme.md

@@ -1,10 +1,10 @@
 # ButlerBot SDK
 
-ButlerBot SDK is a JavaScript library that provides a simple way to interact with the [ButlerBot](https://butlerbot.net/) API.
+ButlerBot SDK is a JavaScript library that provides a simple way to interact with the [ButlerBot](https://butler.now/) API.
 
 ## Quickstart
 
-Grab an API key at [ButlerBot](https://butlerbot.net/) and install the package:
+Grab an API key at [ButlerBot](https://butler.now/) and install the package:
 
 ```bash
 npm i @butlerbot/sdk
@@ -61,8 +61,9 @@ link.addTool(new Tool({
   description: "Brew a coffee for the user",
   schema: z.object({ cups: z.number().int().min(1).max(4) }),
   run: async ({ args, status }) => {
-    status.update("Grinding beans");
-    return `Brewed ${args.cups} cup(s).`;   // args is typed from the schema
+    status.update("Grinding beans");           // progress, shown while it runs
+    status.complete("Brewed the coffee");      // the label the conversation keeps
+    return `Brewed ${args.cups} cup(s).`;      // args is typed from the schema
   },
 }));