@butlerbot/sdk 0.0.8 → 0.0.10-alpha

package/dist/config.d.ts

@@ -22,6 +22,11 @@ export declare const CONFIG: {
                 };
             };
         };
+        stream: {
+            v4: {
+                base: string;
+            };
+        };
         usage: {
             policy: {
                 v3: {

package/dist/config.js

@@ -17,6 +17,9 @@ exports.CONFIG = {
                 v1: { base: "/api/convo/get/history" }
             }
         },
+        stream: {
+            v4: { base: "/api/alfred/v4/chat/stream" }
+        },
         usage: {
             policy: {
                 v3: { base: "/api/user/usage/v3/policy" },

package/dist/modules/conversation.d.ts

@@ -33,6 +33,8 @@ 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;
     /** Whether to enable debug logs */
     debug?: boolean;
     /** The API version to use */
@@ -55,6 +57,8 @@ 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 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 */
@@ -76,6 +80,8 @@ export declare class Conversation {
     getConversationEndpoint(): string;
     /** Gets the current history endpoint */
     getHistoryEndpoint(): string;
+    /** Gets the current stream endpoint */
+    getStreamEndpoint(): string;
     /** Gets the current options object */
     getModel(): string | undefined;
     /** Gets the current location-specific instructions */
@@ -84,9 +90,12 @@ export declare class Conversation {
     getPlatform(): string | undefined;
     /** Gets the current personality configuration */
     getPersonality(): string | undefined;
+    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): void;
     /** Sends a message into the conversation */
-    send(message: string, cb: (chunk: RequestResponse) => any, options?: DialogueRequestOptions): Promise<void>;
+    send(message: string, cb: (chunk: RequestResponse) => any, options?: DialogueRequestOptions): void;
 }
 export {};

package/dist/modules/conversation.js

@@ -21,6 +21,7 @@ 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),
         };
         this.apiKey = config.apiKey;
         this.debug = config.debug || false;
@@ -44,6 +45,11 @@ 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;
+        return this;
+    }
     /** Sets the conversation ID, has to be an existing conversation ID, undefined otherwise */
     setConvoId(convoId) {
         this.convoId = convoId;
@@ -89,6 +95,10 @@ class Conversation {
     getHistoryEndpoint() {
         return this.endpoints.history;
     }
+    /** Gets the current stream endpoint */
+    getStreamEndpoint() {
+        return this.endpoints.stream;
+    }
     /** Gets the current options object */
     getModel() {
         var _a;
@@ -109,6 +119,23 @@ class Conversation {
         var _a;
         return (_a = this.options) === null || _a === void 0 ? void 0 : _a.personality;
     }
+    // SSE HANDLER
+    handleSSE(url, cb, options = {}) {
+        const sse = new eventsource_1.EventSource(url);
+        sse.addEventListener("message", (event) => {
+            const data = JSON.parse(event.data);
+            const convoId = data.success ? data.data.convoId : undefined;
+            if (convoId && options.onConvoId)
+                options.onConvoId(convoId);
+            cb(data);
+            if (data.data.quitStream)
+                sse.close();
+        });
+        sse.addEventListener("error", (event) => {
+            if (this.debug)
+                console.warn(`[Stream Error: ${url}]`, event);
+        });
+    }
     // GETTERS
     /** Fetches the conversation state from the server, including message history and metadata */
     fetchState() {
@@ -125,40 +152,22 @@ class Conversation {
             return data;
         });
     }
+    /** Fetches the conversation stream from the server */
+    fetchStream(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 });
+        return this.handleSSE(url, cb);
+    }
     // LIFE CYCLE
     /** Sends a message into the conversation */
     send(message, cb, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const payload = Object.assign(Object.assign({ message }, this.options), options // overwrite convos for this call
-            );
-            if (this.convoId)
-                payload.chatId = this.convoId;
-            const url = (0, url_formatter_1.formatURL)(this.endpoints.conversation, payload, { apiKey: this.apiKey, debug: this.debug });
-            const sse = new eventsource_1.EventSource(url);
-            sse.addEventListener("message", (event) => {
-                const data = JSON.parse(event.data);
-                const convoId = data.success ? data.data.convoId : undefined;
-                if (convoId)
-                    this.convoId = convoId; // update convo id from response
-                cb(data);
-                if (data.data.quitStream)
-                    sse.close();
-            });
-            sse.addEventListener("error", (event) => {
-                if (this.debug)
-                    console.warn(`[Stream Error: ${url}]`, event);
-                cb({
-                    success: false,
-                    data: {
-                        code: "STREAM_ERROR",
-                        error: "Stream error",
-                        message: event.message || "An error occurred while streaming",
-                        quitStream: true
-                    }
-                });
-                sse.close();
-            });
-        });
+        const payload = Object.assign(Object.assign({ message }, this.options), options // overwrite convos for this call
+        );
+        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 });
     }
 }
 exports.Conversation = Conversation;

package/dist/types/usage/policy.d.ts

@@ -20,6 +20,17 @@ export type UsagePolicy = {
     rules: PolicyRule[];
     maxConvoLength?: number;
 };
+export type UsagePolicyDataUsage = {
+    /** The current user's usage cost for this time period */
+    usage: number;
+    /** The user's limit for the time period */
+    usageLimit: number;
+    /** Explanation of limit for this time period */
+    limitBreakdown: {
+        description: string;
+        addition: number;
+    }[];
+};
 export type UsagePolicyData = {
     limit: {
         /** Current usage cost as a percentage of daily limit (0–1) */
@@ -36,10 +47,11 @@ export type UsagePolicyData = {
     };
     /** Usage policy information */
     usagePolicy: UsagePolicy;
-    daily: {
-        /** The current user's usage cost */
-        dailyUsageCost: number;
-        /** The user's cost limit for the conversation (e.g., daily limit) */
-        dailyUsageCostLimit: number;
+    /** Usage information */
+    usage: {
+        /** Daily usage data */
+        daily: UsagePolicyDataUsage;
+        /** Weekly usage data */
+        weekly: UsagePolicyDataUsage;
     };
 };

package/package.json

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