@butlerbot/sdk 0.0.43 → 0.0.45

package/dist/link/protocol.d.ts

@@ -120,6 +120,8 @@ export type LinkClientPayloads = {
         model?: string;
         instructions?: string;
         personality?: string;
+        /** Why Alfred is speaking on this one turn: a line for its system prompt, at most 500 characters. */
+        wake?: string;
     };
     "conversation.end": {
         sessionId: string;

package/dist/modules/conversation.d.ts

@@ -27,6 +27,14 @@ export type DialogueRequestParams = {
     address?: ConversationAddress;
     /** Custom personality configuration for the AI */
     personality?: string;
+    /**
+     * Why Alfred is speaking on this turn, when something other than the message is the
+     * reason — for example "You are joining because a rule of the user's matched: ...".
+     * A line added to this one turn's system prompt and never written to the conversation,
+     * so it is passed per `send()`/`ask()` rather than set on the conversation. At most
+     * 500 characters; the server refuses a longer one. Left off when blank.
+     */
+    wake?: string;
 };
 export type DialogueRequestOptions = Omit<Omit<DialogueRequestParams, "message">, "chatId">;
 export interface RequestResponseByVersion {

package/dist/modules/transport.d.ts

@@ -58,6 +58,8 @@ export type TransportTurnRequest = {
     /** Where on the platform the conversation is: on Discord, the channel and thread. */
     address?: ConversationAddress;
     personality?: string;
+    /** Why Alfred is speaking on this one turn: a line for its system prompt, at most 500 characters. */
+    wake?: string;
 };
 export type TransportHandlers = {
     /** One payload of the stream, already in the shape callers expect. */

package/dist/modules/transport_link.js

@@ -184,6 +184,8 @@ class LinkConversationTransport {
                 ...(request.model ? { model: request.model } : {}),
                 ...(request.instructions ? { instructions: request.instructions } : {}),
                 ...(request.personality ? { personality: request.personality } : {}),
+                // Per turn, never on the session: it says why Alfred was woken for this one.
+                ...(request.wake?.trim() ? { wake: request.wake.trim() } : {}),
             }, {
                 // A turn takes as long as it takes; only the transport dying ends it early.
                 timeoutMs: 0,

package/dist/modules/transport_sse.js

@@ -120,5 +120,8 @@ function asQuery(request) {
         query.address = JSON.stringify(request.address);
     if (request.personality)
         query.personality = request.personality;
+    const wake = request.wake?.trim();
+    if (wake)
+        query.wake = wake;
     return query;
 }

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

@@ -21,4 +21,12 @@ export type DiscordAddress = {
     platform: "discord";
     channelId: string;
     threadId?: string;
+    /**
+     * The message the conversation was last held at — the user's most recent message in it.
+     *
+     * Anything Alfred says on the conversation outside a turn is posted as a reply to it, so a
+     * background task reporting back an hour later still says what it is answering, in a
+     * channel that has moved on since.
+     */
+    messageId?: string;
 };

package/dist/types/outreach/delivery.d.ts

@@ -1,3 +1,4 @@
+import type { ConversationAddress } from "../conversation/address";
 /**
  * Outreach: what Alfred has told or asked this user outside a chat, and their answers.
  *
@@ -18,8 +19,13 @@ export type DeliverySurfaceStatus = typeof DELIVERY_SURFACE_STATUSES[number];
 export type DeliverySurface = {
     surface: DeliverySurfaceName;
     status: DeliverySurfaceStatus;
-    /** Where on the surface it went: a Discord channel id, or "DM". */
-    channelId?: string | null;
+    /**
+     * Where on the surface it was addressed, whole, as the conversation named it.
+     *
+     * Null when the conversation named none, in which case it went wherever the surface
+     * reaches its user by default: on Discord, their direct messages.
+     */
+    address?: ConversationAddress | null;
     /** What the channel called the message it sent. */
     messageId?: string | null;
     /** Why the last attempt failed. */

package/dist/types/outreach/delivery.js

@@ -1,4 +1,7 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DELIVERY_SOURCES = exports.DELIVERY_CLOSED_REASONS = exports.DELIVERY_ANSWER_VIA = exports.DELIVERY_SURFACE_STATUSES = exports.DELIVERY_SURFACES = exports.ANSWERABLE_DELIVERY_INTENTS = exports.DELIVERY_INTENTS = void 0;
+exports.isDeliveryOpen = isDeliveryOpen;
 /**
  * Outreach: what Alfred has told or asked this user outside a chat, and their answers.
  *
@@ -6,9 +9,6 @@
  * notification about one. Answering closes it, and when it belongs to a job the answer is put
  * on that job's inbox.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DELIVERY_SOURCES = exports.DELIVERY_CLOSED_REASONS = exports.DELIVERY_ANSWER_VIA = exports.DELIVERY_SURFACE_STATUSES = exports.DELIVERY_SURFACES = exports.ANSWERABLE_DELIVERY_INTENTS = exports.DELIVERY_INTENTS = void 0;
-exports.isDeliveryOpen = isDeliveryOpen;
 exports.DELIVERY_INTENTS = ["question", "update", "approval", "statement"];
 /** The intents that leave something outstanding until the user answers. */
 exports.ANSWERABLE_DELIVERY_INTENTS = ["question", "approval"];

package/package.json

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