@butlerbot/sdk 0.0.41 → 0.0.43

package/dist/link/protocol.d.ts

@@ -1,4 +1,5 @@
 import { ConversationEvent } from "../types/response/v5";
+import type { ConversationAddress } from "../types/conversation/address";
 /**
  * LINK WIRE PROTOCOL (client side)
  * ===============================
@@ -110,6 +111,8 @@ export type LinkClientPayloads = {
         personality?: string;
         instructions?: string;
         platform?: string;
+        /** Where on the platform the conversation is: on Discord, the channel and thread. */
+        address?: ConversationAddress;
     };
     "conversation.chat": {
         sessionId: string;

package/dist/modules/conversation.d.ts

@@ -5,6 +5,7 @@ import { ConversationStream, SteerResult, TurnStopMode, TurnStopped } from "./tr
 import { RequestResponseV3, RequestResponseV4 } from "../types/type_registry";
 import { RequestResponseV5 } from "../types/response/v5/dialogue_response_v5";
 import { ConversationStateResponse } from "../types/state/convo_state_response";
+import { ConversationAddress } from "../types/conversation/address";
 import { TurnProgressEntry } from "../types/response/v4/turn_registry_v4";
 import { TurnProgressEntryV5 } from "../types/response/v5/turn_registry_v5";
 export type DialogueRequestParams = {
@@ -18,6 +19,12 @@ export type DialogueRequestParams = {
     instructions?: string;
     /** Platform where the chat is occurring */
     platform?: string;
+    /**
+     * Where on the platform the conversation is — on Discord, the channel and the thread
+     * inside it. Anything Alfred has to say on this conversation outside a turn is delivered
+     * there. An address is whole: a new one replaces the old rather than merging into it.
+     */
+    address?: ConversationAddress;
     /** Custom personality configuration for the AI */
     personality?: string;
 };
@@ -111,6 +118,13 @@ export declare class Conversation<V extends APIPath = "v4"> {
     setInstructions(instructions: string): this;
     /** Sets the platform where the chat is occurring, used internally for logging - ignore in most contexts */
     setPlatform(platform: string): this;
+    /**
+     * Sets where on the platform the conversation is — on Discord, the channel and the thread
+     * inside it. Anything Alfred has to say on this conversation outside a turn is delivered
+     * there. The address is whole: this replaces whatever the conversation named before rather
+     * than merging into it, so a conversation that left a thread stops naming one.
+     */
+    setAddress(address: ConversationAddress): this;
     /** Sets a custom personality configuration for the AI */
     setPersonality(personality: string): this;
     /** Gets the current conversation ID */
@@ -134,6 +148,8 @@ export declare class Conversation<V extends APIPath = "v4"> {
     getInstructions(): string | undefined;
     /** Gets the current platform */
     getPlatform(): string | undefined;
+    /** Gets where on the platform the conversation is */
+    getAddress(): import("../types/type_registry").DiscordAddress | undefined;
     /** Gets the current personality configuration */
     getPersonality(): string | undefined;
     /**

package/dist/modules/conversation.js

@@ -34,6 +34,7 @@ class Conversation {
                 personality: this.options?.personality,
                 instructions: this.options?.instructions,
                 platform: this.options?.platform,
+                address: this.options?.address,
             }));
         }
         else {
@@ -95,6 +96,16 @@ class Conversation {
         this.options = { ...this.options, platform };
         return this;
     }
+    /**
+     * Sets where on the platform the conversation is — on Discord, the channel and the thread
+     * inside it. Anything Alfred has to say on this conversation outside a turn is delivered
+     * there. The address is whole: this replaces whatever the conversation named before rather
+     * than merging into it, so a conversation that left a thread stops naming one.
+     */
+    setAddress(address) {
+        this.options = { ...this.options, address };
+        return this;
+    }
     /** Sets a custom personality configuration for the AI */
     setPersonality(personality) {
         this.options = { ...this.options, personality };
@@ -140,6 +151,10 @@ class Conversation {
     getPlatform() {
         return this.options?.platform;
     }
+    /** Gets where on the platform the conversation is */
+    getAddress() {
+        return this.options?.address;
+    }
     /** Gets the current personality configuration */
     getPersonality() {
         return this.options?.personality;

package/dist/modules/transport.d.ts

@@ -6,6 +6,7 @@
  * only decides how a turn is sent and how its stream comes back — everything a
  * caller sees, including the payload shape, is identical either way.
  */
+import type { ConversationAddress } from "../types/conversation/address";
 /** A turn in progress. */
 export type ConversationStream = {
     /**
@@ -54,6 +55,8 @@ export type TransportTurnRequest = {
     model?: string;
     instructions?: string;
     platform?: string;
+    /** Where on the platform the conversation is: on Discord, the channel and thread. */
+    address?: ConversationAddress;
     personality?: string;
 };
 export type TransportHandlers = {

package/dist/modules/transport_link.d.ts

@@ -1,10 +1,13 @@
 import type { Link } from "../link/link";
+import type { ConversationAddress } from "../types/conversation/address";
 import { ConversationStream, ConversationTransport, SteerResult, TransportAttachRequest, TransportHandlers, TransportSteerRequest, TransportStopRequest, TransportTurnRequest, TurnStopped } from "./transport";
 export type LinkSessionConfig = {
     model?: string;
     personality?: string;
     instructions?: string;
     platform?: string;
+    /** Where on the platform the conversation is: on Discord, the channel and thread. */
+    address?: ConversationAddress;
 };
 /**
  * Carries a turn over an existing Link connection.

package/dist/modules/transport_link.js

@@ -396,6 +396,7 @@ class LinkConversationTransport {
             ...(request.personality ?? config.personality ? { personality: request.personality ?? config.personality } : {}),
             ...(request.instructions ?? config.instructions ? { instructions: request.instructions ?? config.instructions } : {}),
             ...(request.platform ?? config.platform ? { platform: request.platform ?? config.platform } : {}),
+            ...(request.address ?? config.address ? { address: request.address ?? config.address } : {}),
         }, {
             isDone: (frame) => frame.type === "conversation.open",
         });

package/dist/modules/transport_sse.js

@@ -114,6 +114,10 @@ function asQuery(request) {
         query.instructions = request.instructions;
     if (request.platform)
         query.platform = request.platform;
+    // An address is a small object, and a query parameter is a string: it travels JSON-encoded
+    // rather than as a field per part, so the server reads one whole address or none at all.
+    if (request.address)
+        query.address = JSON.stringify(request.address);
     if (request.personality)
         query.personality = request.personality;
     return query;

package/dist/types/conversation/address.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Where a conversation lives on the platform it is being held on.
+ *
+ * Anything Alfred has to say on a conversation outside a turn — a background task reporting
+ * what it found — is delivered to the address the conversation named. A conversation that
+ * names none is answered wherever the platform's own default is, which on Discord is the
+ * user's direct messages.
+ *
+ * An address is whole: a new one replaces the old outright rather than being merged into it,
+ * so a conversation that moves out of a thread stops naming the thread it was in.
+ */
+export type ConversationAddress = DiscordAddress;
+/**
+ * A place on Discord.
+ *
+ * `channelId` is the guild text or forum channel, or the literal `"DM"` for the user's direct
+ * messages. `threadId` is the thread or forum post inside that channel, when the conversation
+ * is in one — a forum post being a thread whose channel is the forum.
+ */
+export type DiscordAddress = {
+    platform: "discord";
+    channelId: string;
+    threadId?: string;
+};

package/dist/types/conversation/address.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/jobs/job.d.ts

@@ -5,7 +5,7 @@ import type { Delivery } from "../outreach/delivery";
  * These are the shapes the jobs routes answer with. The server flattens a job row into a
  * `JobView` before it leaves, and this is that view rather than the row.
  */
-export declare const JOB_STATUSES: readonly ["queued", "running", "blocked", "waiting_user", "waiting_approval", "waiting_child", "waiting_budget", "review", "done", "failed", "cancelled"];
+export declare const JOB_STATUSES: readonly ["queued", "running", "blocked", "waiting_user", "waiting_approval", "waiting_child", "waiting_task", "waiting_budget", "review", "done", "failed", "cancelled"];
 export type JobStatus = typeof JOB_STATUSES[number];
 /** The statuses a job never leaves. */
 export declare const TERMINAL_JOB_STATUSES: readonly JobStatus[];

package/dist/types/jobs/job.js

@@ -15,6 +15,11 @@ exports.JOB_STATUSES = [
     "waiting_user",
     "waiting_approval",
     "waiting_child",
+    /**
+     * Parked with no wake time, on a tool call one of its shifts started that is still
+     * running in the background as a task; the task settling re-queues the job.
+     */
+    "waiting_task",
     "waiting_budget",
     "review",
     "done",

package/dist/types/type_registry.d.ts

@@ -3,6 +3,7 @@ export * from "./response/v4";
 export * from "./response/v5";
 export * from "./state/convo_state_response";
 export * from "./conversation/v4/conversation_v4";
+export * from "./conversation/address";
 export * from "./jobs";
 export * from "./outreach";
 export * from "./error";

package/dist/types/type_registry.js

@@ -19,6 +19,7 @@ __exportStar(require("./response/v4"), exports);
 __exportStar(require("./response/v5"), exports);
 __exportStar(require("./state/convo_state_response"), exports);
 __exportStar(require("./conversation/v4/conversation_v4"), exports);
+__exportStar(require("./conversation/address"), exports);
 __exportStar(require("./jobs"), exports);
 __exportStar(require("./outreach"), exports);
 __exportStar(require("./error"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@butlerbot/sdk",
-	"version": "0.0.41",
+	"version": "0.0.43",
 	"description": "The official ButlerBot SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",