@butlerbot/sdk 0.0.6-alpha.2 → 0.0.6-alpha.4

package/dist/config.d.ts

@@ -10,5 +10,17 @@ export declare const CONFIG: {
                 base: string;
             };
         };
+        history: {
+            chat: {
+                v1: {
+                    base: string;
+                };
+            };
+            chats: {
+                v1: {
+                    base: string;
+                };
+            };
+        };
     };
 };

package/dist/config.js

@@ -8,6 +8,14 @@ exports.CONFIG = {
         conversation: {
             v3: { base: "/api/alfred/v3/chat" },
             v4: { base: "/api/alfred/v4/chat" },
+        },
+        history: {
+            chat: {
+                v1: { base: "/api/convo/chat" },
+            },
+            chats: {
+                v1: { base: "/api/convo/get/history" }
+            }
         }
     }
 };

package/dist/modules/conversation.d.ts

@@ -1,5 +1,6 @@
 import { CONFIG } from "../config";
 import { RequestResponseV3 } from "../types/type_registry";
+import { ConversationStateResponse } from "../types/state/convo_state_response";
 export type DialogueRequestParams = {
     /** Unique identifier for the chat session */
     chatId?: string;
@@ -23,12 +24,19 @@ export type ConversationOptions = {
     apiKey: string;
     /** The server URL to use */
     serverUrl?: string;
-    /** The path to append to the server URL specifying the API endpoint to use */
+    /**
+     * The path to append to the server URL specifying the API endpoint to use (specifically for conversations)
+     * @deprecated use convoPath instead
+    */
     path?: string;
+    /** The path to append to the server URL specifying the conversation API endpoint to use */
+    convoPath?: string;
+    /** The path to append to the server URL specifying the history API endpoint to use */
+    historyPath?: string;
     /** Whether to enable debug logs */
     debug?: boolean;
     /** The API version to use */
-    api?: APIPath;
+    chatApiV?: APIPath;
 };
 export type RequestResponse = RequestResponseV3;
 export declare class Conversation {
@@ -36,10 +44,17 @@ export declare class Conversation {
     apiKey: string;
     private debug;
     private options?;
-    private endpoint;
+    private endpoints;
     constructor(config: ConversationOptions);
-    /** Sets the endpoint where the request is sent to, appended to server URL */
+    /**
+     * Sets the endpoint where the request is sent to, appended to server URL
+     * @deprecated Use setConversationEndpoint() instead
+     */
     setEndpoint(endpoint: string): this;
+    /** Sets the conversation endpoint where the request is sent to, appended to server URL */
+    setConversationEndpoint(conversationEndpoint: string): this;
+    /** Sets the history endpoint where the quest is sent to, appended to server URL */
+    setHistoryEndpoint(historyEndpoint: 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 */
@@ -52,8 +67,15 @@ export declare class Conversation {
     setPersonality(personality: string): this;
     /** Gets the current conversation ID */
     getConvoId(): string | undefined;
-    /** Gets the current endpoint */
+    /**
+     * Gets the current endpoint
+     * @deprecated Use getConversationEndpoint() instead
+    */
     getEndpoint(): string;
+    /** Gets the current conversation endpoint */
+    getConversationEndpoint(): string;
+    /** Gets the current history endpoint */
+    getHistoryEndpoint(): string;
     /** Gets the current options object */
     getModel(): string | undefined;
     /** Gets the current location-specific instructions */
@@ -62,6 +84,9 @@ export declare class Conversation {
     getPlatform(): string | undefined;
     /** Gets the current personality configuration */
     getPersonality(): string | undefined;
+    formatURL(url: string, params?: Object): string;
+    /** Fetches the conversation state from the server, including message history and metadata */
+    fetchState(): Promise<ConversationStateResponse>;
     /** Sends a message into the conversation */
     send(message: string, cb: (chunk: RequestResponse) => any, options?: DialogueRequestOptions): Promise<void>;
 }

package/dist/modules/conversation.js

@@ -12,18 +12,35 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Conversation = void 0;
 const eventsource_1 = require("eventsource");
 const config_1 = require("../config");
-const DEFAULT_API = "v3";
+const DEFAULT_CONVO_API_V = "v3";
 class Conversation {
     constructor(config) {
         this.convoId = config.convoId;
-        this.endpoint = (config.serverUrl || config_1.CONFIG.server) + (config.path || config_1.CONFIG.paths.conversation[config.api || DEFAULT_API].base);
+        const serverUrl = config.serverUrl || config_1.CONFIG.server;
+        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),
+        };
         this.apiKey = config.apiKey;
         this.debug = config.debug || false;
     }
     // SETTERS
-    /** Sets the endpoint where the request is sent to, appended to server URL */
+    /**
+     * Sets the endpoint where the request is sent to, appended to server URL
+     * @deprecated Use setConversationEndpoint() instead
+     */
     setEndpoint(endpoint) {
-        this.endpoint = endpoint;
+        this.endpoints.conversation = endpoint;
+        return this;
+    }
+    /** Sets the conversation endpoint where the request is sent to, appended to server URL */
+    setConversationEndpoint(conversationEndpoint) {
+        this.endpoints.conversation = conversationEndpoint;
+        return this;
+    }
+    /** Sets the history endpoint where the quest is sent to, appended to server URL */
+    setHistoryEndpoint(historyEndpoint) {
+        this.endpoints.history = historyEndpoint;
         return this;
     }
     /** Sets the conversation ID, has to be an existing conversation ID, undefined otherwise */
@@ -56,9 +73,20 @@ class Conversation {
     getConvoId() {
         return this.convoId;
     }
-    /** Gets the current endpoint */
+    /**
+     * Gets the current endpoint
+     * @deprecated Use getConversationEndpoint() instead
+    */
     getEndpoint() {
-        return this.endpoint;
+        return this.endpoints.conversation;
+    }
+    /** Gets the current conversation endpoint */
+    getConversationEndpoint() {
+        return this.endpoints.conversation;
+    }
+    /** Gets the current history endpoint */
+    getHistoryEndpoint() {
+        return this.endpoints.history;
     }
     /** Gets the current options object */
     getModel() {
@@ -80,25 +108,44 @@ class Conversation {
         var _a;
         return (_a = this.options) === null || _a === void 0 ? void 0 : _a.personality;
     }
+    // HELPERS
+    formatURL(url, params = {}) {
+        const fParams = Object.assign({ api_key: this.apiKey }, params);
+        const paramQuery = new URLSearchParams(fParams).toString();
+        const fUrl = `${url}?${paramQuery}`;
+        if (this.debug) {
+            const debugUrl = new URL(fUrl);
+            const apiKey = debugUrl.searchParams.get('api_key');
+            if (apiKey) {
+                const obscuredKey = apiKey.length > 6 ? `${apiKey.slice(0, 3)}...${apiKey.slice(-3)}` : '***';
+                debugUrl.searchParams.set('api_key', obscuredKey);
+            }
+            console.log(`[Formatting URL ${debugUrl.toString()}]`);
+        }
+        return fUrl;
+    }
+    // GETTERS
+    /** Fetches the conversation state from the server, including message history and metadata */
+    fetchState() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.convoId)
+                throw new Error("Conversation ID is not set");
+            const url = this.formatURL(`${this.endpoints.history}/${this.convoId}`);
+            const response = yield fetch(url);
+            if (!response.ok) {
+                const errorText = yield response.text();
+                throw new Error(`Failed to fetch conversation state: ${response.status} ${response.statusText} - ${errorText}`);
+            }
+            const data = yield response.json();
+            return data;
+        });
+    }
     // LIFE CYCLE
     /** Sends a message into the conversation */
     send(message, cb, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const params = Object.assign(Object.assign({ message, api_key: this.apiKey }, this.options), options // overwrite convos for this call
-            );
-            if (this.convoId)
-                params.chatId = this.convoId;
-            const paramQuery = new URLSearchParams(params).toString();
-            const url = `${this.endpoint}?${paramQuery}`;
-            if (this.debug) {
-                const debugUrl = new URL(url);
-                const apiKey = debugUrl.searchParams.get('api_key');
-                if (apiKey) {
-                    const obscuredKey = apiKey.length > 6 ? `${apiKey.slice(0, 3)}...${apiKey.slice(-3)}` : '***';
-                    debugUrl.searchParams.set('api_key', obscuredKey);
-                }
-                console.log(`[Requesting URL ${debugUrl.toString()}]`);
-            }
+            const url = this.formatURL(this.endpoints.conversation, Object.assign(Object.assign({ chatId: this.convoId, message }, this.options), options // overwrite convos for this call
+            ));
             const sse = new eventsource_1.EventSource(url);
             sse.addEventListener("message", (event) => {
                 const data = JSON.parse(event.data);

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

@@ -0,0 +1,3 @@
+export * from "./v1";
+export * from "./v2";
+export * from "./v3";

package/dist/types/conversation/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./v1"), exports);
+__exportStar(require("./v2"), exports);
+__exportStar(require("./v3"), exports);

package/dist/types/conversation/v1/conversation_v1.d.ts

@@ -0,0 +1,7 @@
+export interface ConversationV1 {
+    version?: "1.0";
+    conversationId: string;
+    ownerUserId: string;
+    /** The actual profile data */
+    profile: Object;
+}

package/dist/types/conversation/v1/conversation_v1.js

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

package/dist/types/conversation/v1/index.d.ts

@@ -0,0 +1 @@
+export * from "./conversation_v1";

package/dist/types/conversation/v1/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./conversation_v1"), exports);