@butlerbot/sdk 0.0.10-alpha.3 → 0.0.11

package/dist/config.d.ts

@@ -22,9 +22,10 @@ export declare const CONFIG: {
                 };
             };
         };
-        stream: {
+        progress: {
             v4: {
                 base: string;
+                stream: string;
             };
         };
         usage: {

package/dist/config.js

@@ -17,8 +17,11 @@ exports.CONFIG = {
                 v1: { base: "/api/convo/get/history" }
             }
         },
-        stream: {
-            v4: { base: "/api/alfred/v4/chat/stream" }
+        progress: {
+            v4: {
+                base: "/api/alfred/v4/chat/progress",
+                stream: "/api/alfred/v4/chat/progress/stream",
+            }
         },
         usage: {
             policy: {

package/dist/modules/conversation.d.ts

@@ -34,8 +34,10 @@ export type ConversationOptions = {
     convoPath?: string;
     /** The path to append to the server URL specifying the history API endpoint to use */
     historyPath?: string;
-    /** The path to append to the server URL specifying the stream API endpoint to use */
-    streamPath?: string;
+    /** The path to append to the server URL specifying the progress API endpoint to use */
+    progressPath?: string;
+    /** The path to append to the server URL specifying the progress stream API endpoint to use */
+    progressStreamPath?: string;
     /** Whether to enable debug logs */
     debug?: boolean;
     /** The API version to use */
@@ -58,8 +60,10 @@ export declare class Conversation {
     setConversationEndpoint(conversationEndpoint: string): this;
     /** Sets the history endpoint where the quest is sent to, appended to server URL */
     setHistoryEndpoint(historyEndpoint: string): this;
-    /** Sets the stream endpoint where the request is sent to, appended to server URL */
-    setStreamEndpoint(streamEndpoint: string): this;
+    /** Sets the progress stream endpoint where the request is sent to, appended to server URL */
+    setProgressStreamEndpoint(progressStreamEndpoint: string): this;
+    /** Sets the progress endpoint where the request is sent to, appended to server URL */
+    setProgressEndpoint(progressEndpoint: string): this;
     /** Sets the conversation ID, has to be an existing conversation ID, undefined otherwise */
     setConvoId(convoId: string | undefined): this;
     /** Sets the AI model used for the next interaction, e.g Claude-Sonnet, GPT-4 */
@@ -81,8 +85,10 @@ export declare class Conversation {
     getConversationEndpoint(): string;
     /** Gets the current history endpoint */
     getHistoryEndpoint(): string;
-    /** Gets the current stream endpoint */
-    getStreamEndpoint(): string;
+    /** Gets the current progress stream endpoint */
+    getProgressStreamEndpoint(): string;
+    /** Gets the current progress endpoint */
+    getProgressEndpoint(): string;
     /** Gets the current options object */
     getModel(): string | undefined;
     /** Gets the current location-specific instructions */
@@ -94,8 +100,10 @@ export declare class Conversation {
     private handleSSE;
     /** Fetches the conversation state from the server, including message history and metadata */
     fetchState(): Promise<ConversationStateResponse>;
-    /** Fetches the conversation stream from the server */
-    fetchStream(cb: (chunk: RequestResponse) => any): EventSource;
+    /** Fetches the conversation progress stream from the server */
+    fetchProgressStream(cb: (chunk: RequestResponse) => any): EventSource;
+    /** Fetches the conversation progress from the server */
+    fetchProgress(): Promise<RequestResponse[]>;
     /** Sends a message into the conversation */
     send(message: string, cb: (chunk: RequestResponse) => any, options?: DialogueRequestOptions): EventSource;
 }

package/dist/modules/conversation.js

@@ -21,7 +21,8 @@ class Conversation {
         this.endpoints = {
             conversation: serverUrl + (config.convoPath || config.path || config_1.CONFIG.paths.conversation[config.chatApiV || DEFAULT_CONVO_API_V].base),
             history: serverUrl + (config.historyPath || config_1.CONFIG.paths.history.chat.v1.base),
-            stream: serverUrl + (config.streamPath || config_1.CONFIG.paths.stream.v4.base),
+            progressStream: serverUrl + (config.progressStreamPath || config_1.CONFIG.paths.progress.v4.stream),
+            progress: serverUrl + (config.progressPath || config_1.CONFIG.paths.progress.v4.base),
         };
         this.apiKey = config.apiKey;
         this.debug = config.debug || false;
@@ -45,9 +46,14 @@ class Conversation {
         this.endpoints.history = historyEndpoint;
         return this;
     }
-    /** Sets the stream endpoint where the request is sent to, appended to server URL */
-    setStreamEndpoint(streamEndpoint) {
-        this.endpoints.stream = streamEndpoint;
+    /** Sets the progress stream endpoint where the request is sent to, appended to server URL */
+    setProgressStreamEndpoint(progressStreamEndpoint) {
+        this.endpoints.progressStream = progressStreamEndpoint;
+        return this;
+    }
+    /** Sets the progress endpoint where the request is sent to, appended to server URL */
+    setProgressEndpoint(progressEndpoint) {
+        this.endpoints.progress = progressEndpoint;
         return this;
     }
     /** Sets the conversation ID, has to be an existing conversation ID, undefined otherwise */
@@ -95,9 +101,13 @@ class Conversation {
     getHistoryEndpoint() {
         return this.endpoints.history;
     }
-    /** Gets the current stream endpoint */
-    getStreamEndpoint() {
-        return this.endpoints.stream;
+    /** Gets the current progress stream endpoint */
+    getProgressStreamEndpoint() {
+        return this.endpoints.progressStream;
+    }
+    /** Gets the current progress endpoint */
+    getProgressEndpoint() {
+        return this.endpoints.progress;
     }
     /** Gets the current options object */
     getModel() {
@@ -153,13 +163,28 @@ class Conversation {
             return data;
         });
     }
-    /** Fetches the conversation stream from the server */
-    fetchStream(cb) {
+    /** Fetches the conversation progress stream from the server */
+    fetchProgressStream(cb) {
         if (!this.convoId)
             throw new Error("Conversation ID is not set");
-        const url = (0, url_formatter_1.formatURL)(this.endpoints.stream, { chatId: this.convoId }, { apiKey: this.apiKey, debug: this.debug });
+        const url = (0, url_formatter_1.formatURL)(this.endpoints.progressStream, { chatId: this.convoId }, { apiKey: this.apiKey, debug: this.debug });
         return this.handleSSE(url, cb);
     }
+    /** Fetches the conversation progress from the server */
+    fetchProgress() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.convoId)
+                throw new Error("Conversation ID is not set");
+            const url = (0, url_formatter_1.formatURL)(this.endpoints.progress, { chatId: this.convoId }, { apiKey: this.apiKey, debug: this.debug });
+            const response = yield fetch(url, { headers: { "Authorization": `Bearer ${this.apiKey}` } });
+            if (!response.ok) {
+                const errorText = yield response.text();
+                throw new Error(`Failed to fetch conversation progress: ${response.status} ${response.statusText} - ${errorText}`);
+            }
+            const data = yield response.json();
+            return data.events;
+        });
+    }
     // LIFE CYCLE
     /** Sends a message into the conversation */
     send(message, cb, options) {

package/dist/types/conversation/v3/conversation_v3.d.ts

@@ -170,11 +170,12 @@ export type ToolPayload = {
     status: ToolStatus;
 };
 export type ConvoStatusPayload = {
-    /** Whether the entire AI convo has been disabled, a disabled convo cannot be restarted */
-    disabled?: boolean;
-    /** Whether the AI convo has been stopped, a stopped convo can be restarted
-         * although just because it's not stopped does not necasserily mean it's an ongoing conversation */
-    stopped?: boolean;
+    /** The state of the conversation.
+     * - `disabled`: The conversation has been permanently disabled and cannot be restarted.
+     * - `stopped`: The conversation has been stopped but can be restarted.
+     * - `started`: The conversation has been started/restarted.
+     */
+    state?: "disabled" | "stopped" | "started";
     /** Short summary generated for this conversation */
     shortSummary?: string;
 };

package/package.json

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