@butlerbot/sdk 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -22,7 +22,4 @@ export declare class ButlerBotClient {
     createConversation(config?: OptionalApiKey<ConversationOptions>): Conversation;
 }
 export { Conversation, ConversationOptions };
-export * from "./types/ai_response_v3";
-export * from "./types/dialogue_response_v3";
-export * from "./types/error";
-export * from "./types/ai_tools_v3";
+export * from "./types/type_registry";

package/dist/index.js

@@ -54,8 +54,4 @@ class ButlerBotClient {
     }
 }
 exports.ButlerBotClient = ButlerBotClient;
-// Expose types from /types
-__exportStar(require("./types/ai_response_v3"), exports); // ai_response_v3.ts
-__exportStar(require("./types/dialogue_response_v3"), exports); // dialogue_response_v3.ts
-__exportStar(require("./types/error"), exports); // error.ts
-__exportStar(require("./types/ai_tools_v3"), exports); // ai_tools_v3.ts
+__exportStar(require("./types/type_registry"), exports);

package/dist/modules/conversation.d.ts

@@ -13,6 +13,7 @@ export type DialogueRequestParams = {
     /** Custom personality configuration for the AI */
     personality?: string;
 };
+export type DialogueRequestOptions = Omit<Omit<DialogueRequestParams, "message">, "chatId">;
 export type ConversationOptions = {
     /** The conversation ID to load the conversation from, server will error if this convo id doesn't exist */
     convoId?: string;
@@ -27,10 +28,35 @@ export type ConversationOptions = {
 };
 export declare class Conversation {
     convoId?: string;
-    endpoint: string;
     apiKey: string;
     private debug;
+    private options?;
+    private endpoint;
     constructor(config: ConversationOptions);
+    /** Sets the endpoint where the request is sent to, appended to server URL */
+    setEndpoint(endpoint: 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 */
+    setModel(model: string): this;
+    /** Sets additional instructions for location-specific context */
+    setInstructions(instructions: string): this;
+    /** Sets the platform where the chat is occurring, used internally for logging - ignore in most contexts */
+    setPlatform(platform: string): this;
+    /** Sets a custom personality configuration for the AI */
+    setPersonality(personality: string): this;
+    /** Gets the current conversation ID */
+    getConvoId(): string | undefined;
+    /** Gets the current endpoint */
+    getEndpoint(): string;
+    /** Gets the current options object */
+    getModel(): string | undefined;
+    /** Gets the current location-specific instructions */
+    getInstructions(): string | undefined;
+    /** Gets the current platform */
+    getPlatform(): string | undefined;
+    /** Gets the current personality configuration */
+    getPersonality(): string | undefined;
     /** Sends a message into the conversation */
-    send(message: string, cb: (chunk: RequestResponse) => any): Promise<void>;
+    send(message: string, cb: (chunk: RequestResponse) => any, options?: DialogueRequestOptions): Promise<void>;
 }

package/dist/modules/conversation.js

@@ -19,13 +19,72 @@ class Conversation {
         this.apiKey = config.apiKey;
         this.debug = config.debug || false;
     }
+    // SETTERS
+    /** Sets the endpoint where the request is sent to, appended to server URL */
+    setEndpoint(endpoint) {
+        this.endpoint = endpoint;
+        return this;
+    }
+    /** Sets the conversation ID, has to be an existing conversation ID, undefined otherwise */
+    setConvoId(convoId) {
+        this.convoId = convoId;
+        return this;
+    }
+    /** Sets the AI model used for the next interaction, e.g Claude-Sonnet, GPT-4 */
+    setModel(model) {
+        this.options = Object.assign(Object.assign({}, this.options), { model });
+        return this;
+    }
+    /** Sets additional instructions for location-specific context */
+    setInstructions(instructions) {
+        this.options = Object.assign(Object.assign({}, this.options), { instructions });
+        return this;
+    }
+    /** Sets the platform where the chat is occurring, used internally for logging - ignore in most contexts */
+    setPlatform(platform) {
+        this.options = Object.assign(Object.assign({}, this.options), { platform });
+        return this;
+    }
+    /** Sets a custom personality configuration for the AI */
+    setPersonality(personality) {
+        this.options = Object.assign(Object.assign({}, this.options), { personality });
+        return this;
+    }
+    // GETTERS
+    /** Gets the current conversation ID */
+    getConvoId() {
+        return this.convoId;
+    }
+    /** Gets the current endpoint */
+    getEndpoint() {
+        return this.endpoint;
+    }
+    /** Gets the current options object */
+    getModel() {
+        var _a;
+        return (_a = this.options) === null || _a === void 0 ? void 0 : _a.model;
+    }
+    /** Gets the current location-specific instructions */
+    getInstructions() {
+        var _a;
+        return (_a = this.options) === null || _a === void 0 ? void 0 : _a.instructions;
+    }
+    /** Gets the current platform */
+    getPlatform() {
+        var _a;
+        return (_a = this.options) === null || _a === void 0 ? void 0 : _a.platform;
+    }
+    /** Gets the current personality configuration */
+    getPersonality() {
+        var _a;
+        return (_a = this.options) === null || _a === void 0 ? void 0 : _a.personality;
+    }
+    // LIFE CYCLE
     /** Sends a message into the conversation */
-    send(message, cb) {
+    send(message, cb, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const params = {
-                message,
-                api_key: this.apiKey
-            };
+            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();

package/dist/types/dialogue_response_v3.d.ts

@@ -17,7 +17,7 @@ export type RequestFailResponse = {
         message: string;
     } & RequestBaseResponsePayload;
 };
-export type RequestSucessResponse = {
+export type RequestSuccessResponse = {
     success: true;
     data: {
         /** The AI's response */
@@ -26,4 +26,4 @@ export type RequestSucessResponse = {
         convoId?: string;
     } & RequestBaseResponsePayload;
 };
-export type RequestResponse = RequestFailResponse | RequestSucessResponse;
+export type RequestResponse = RequestFailResponse | RequestSuccessResponse;

package/dist/types/type_registry.d.ts

@@ -0,0 +1,4 @@
+export * from "./ai_response_v3";
+export * from "./dialogue_response_v3";
+export * from "./error";
+export * from "./ai_tools_v3";

package/dist/types/type_registry.js

@@ -0,0 +1,20 @@
+"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("./ai_response_v3"), exports);
+__exportStar(require("./dialogue_response_v3"), exports);
+__exportStar(require("./error"), exports);
+__exportStar(require("./ai_tools_v3"), exports);

package/package.json

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