@butlerbot/sdk 0.0.13 → 0.0.15

package/dist/modules/conversation.d.ts

@@ -2,6 +2,7 @@ import { EventSource } from "eventsource";
 import { CONFIG } from "../config";
 import { RequestResponseV4 } from "../types/type_registry";
 import { ConversationStateResponse } from "../types/state/convo_state_response";
+import { TurnProgressEntry } from "../types/response/v4/turn_registry_v4";
 export type DialogueRequestParams = {
     /** Unique identifier for the chat session */
     chatId?: string;
@@ -49,6 +50,7 @@ export declare class Conversation {
     apiKey: string;
     private debug;
     private options?;
+    private events;
     private endpoints;
     constructor(config: ConversationOptions);
     /**
@@ -97,6 +99,24 @@ export declare class Conversation {
     getPlatform(): string | undefined;
     /** Gets the current personality configuration */
     getPersonality(): string | undefined;
+    private hasEmitter;
+    private addEmitter;
+    private removeEmitter;
+    private addListener;
+    private removeListener;
+    private emit;
+    /**
+     * Fires when the conversation ID is set
+     * if convoId is already set when this is called, fires immediately
+     * */
+    onConvoId(cb: (convoId: string) => any): string;
+    /** Removes a convoId listener */
+    offConvoId(listenerId: string): void;
+    /**
+     * Fires once when the conversation ID is set, then removes the listener.
+     * If convoId is already set, fires immediately
+     */
+    onceConvoId(cb: (convoId: string) => any): `${string}-${string}-${string}-${string}-${string}` | undefined;
     private handleSSE;
     /** Fetches the conversation state from the server, including message history and metadata */
     fetchState(): Promise<ConversationStateResponse>;
@@ -106,7 +126,7 @@ export declare class Conversation {
      * Fetches the conversation progress from the server
      * Returns undefined if no active turn progress
     */
-    fetchProgress(): Promise<RequestResponse[] | undefined>;
+    fetchProgress(): Promise<TurnProgressEntry[] | undefined>;
     /** Sends a message into the conversation */
     send(message: string, cb: (chunk: RequestResponse) => any, options?: DialogueRequestOptions): EventSource;
 }

package/dist/modules/conversation.js

@@ -16,6 +16,7 @@ const url_formatter_1 = require("../util/url_formatter");
 const DEFAULT_CONVO_API_V = "v4";
 class Conversation {
     constructor(config) {
+        this.events = new Map();
         this.convoId = config.convoId;
         const serverUrl = config.serverUrl || config_1.CONFIG.server;
         this.endpoints = {
@@ -129,6 +130,63 @@ class Conversation {
         var _a;
         return (_a = this.options) === null || _a === void 0 ? void 0 : _a.personality;
     }
+    // EVENT EMITTER
+    hasEmitter(event) {
+        return this.events.has(event);
+    }
+    addEmitter(event) {
+        if (!this.hasEmitter(event))
+            this.events.set(event, new Map());
+    }
+    removeEmitter(event) {
+        this.events.delete(event);
+    }
+    addListener(event, cb) {
+        if (!this.hasEmitter(event))
+            this.addEmitter(event);
+        const listeners = this.events.get(event);
+        const id = crypto.randomUUID();
+        listeners.set(id, cb);
+        return id;
+    }
+    removeListener(event, id) {
+        const listeners = this.events.get(event);
+        if (listeners)
+            listeners.delete(id);
+    }
+    emit(event, ...args) {
+        const listeners = this.events.get(event);
+        if (listeners)
+            listeners.forEach(listener => listener(...args));
+    }
+    /**
+     * Fires when the conversation ID is set
+     * if convoId is already set when this is called, fires immediately
+     * */
+    onConvoId(cb) {
+        if (this.convoId)
+            cb(this.convoId);
+        return this.addListener("convoId", cb);
+    }
+    /** Removes a convoId listener */
+    offConvoId(listenerId) {
+        this.removeListener("convoId", listenerId);
+    }
+    /**
+     * Fires once when the conversation ID is set, then removes the listener.
+     * If convoId is already set, fires immediately
+     */
+    onceConvoId(cb) {
+        if (this.convoId) {
+            cb(this.convoId);
+            return;
+        }
+        const id = this.addListener("convoId", (convoId) => {
+            cb(convoId);
+            this.offConvoId(id);
+        });
+        return id;
+    }
     // SSE HANDLER
     handleSSE(url, cb, options = {}) {
         const sse = new eventsource_1.EventSource(url);
@@ -198,7 +256,12 @@ class Conversation {
         if (this.convoId)
             payload.chatId = this.convoId;
         const url = (0, url_formatter_1.formatURL)(this.endpoints.conversation, payload, { apiKey: this.apiKey, debug: this.debug });
-        return this.handleSSE(url, cb, { onConvoId: (convoId) => this.convoId = convoId });
+        return this.handleSSE(url, cb, {
+            onConvoId: (convoId) => {
+                this.convoId = convoId;
+                this.emit("convoId", convoId);
+            }
+        });
     }
 }
 exports.Conversation = Conversation;

package/dist/types/response/v4/turn_registry_v4.d.ts

@@ -0,0 +1,7 @@
+import { RequestResponseV4 } from "./dialogue_response_v4";
+export type TurnProgressEntry = {
+    /** The ID of the buffered event */
+    eventId: string;
+    /** The actual event payload */
+    event: RequestResponseV4;
+};

package/dist/types/response/v4/turn_registry_v4.js

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

package/package.json

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