@butlerbot/sdk 0.0.1-alpha1 → 0.0.1-alpha2

package/dist/index.d.ts

@@ -21,4 +21,4 @@ export declare class ButlerBotClient {
     /** Spawns a new Conversation, inherits api key and server URL */
     createConversation(config?: OptionalApiKey<ConversationOptions>): Conversation;
 }
-export {};
+export { Conversation, ConversationOptions };

package/dist/index.js

@@ -9,9 +9,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ButlerBotClient = void 0;
+exports.Conversation = exports.ButlerBotClient = void 0;
 const config_1 = require("./config");
 const conversation_1 = require("./modules/conversation");
+Object.defineProperty(exports, "Conversation", { enumerable: true, get: function () { return conversation_1.Conversation; } });
 class ButlerBotClient {
     constructor(config) {
         this.apiKey = config.apiKey;

package/dist/types/ai_response_v3.d.ts

@@ -1,3 +1,4 @@
+import { AIToolStatusData } from "./ai_tools_v3";
 import { ErrorCode } from "./error";
 type AIChatResultFail = {
     success: false;
@@ -52,7 +53,10 @@ type AIConvoStatusResponse = {
 type AIToolResponse = {
     /** Specifies type to be a tool use status update */
     type: "tool";
-    payload: {};
+    payload: {
+        status: string;
+        info: AIToolStatusData;
+    };
     metadata: BaseAIResponseMetadata & {};
 };
 export type AIResponse = AIMessageResponse | AIToolResponse | AIConvoStatusResponse | AIResponseStatusResponse;

package/dist/types/ai_tools_v3.d.ts

@@ -0,0 +1,7 @@
+export type AIToolStatusData = {
+    failed: boolean;
+    done: boolean;
+    id: string;
+    parentId?: string;
+    endingConvo?: boolean;
+};

package/dist/types/ai_tools_v3.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.1-alpha1",
+  "version": "0.0.1-alpha2",
   "description": "The official ButlerBot SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,7 @@
   "scripts": {
     "build": "tsc",
     "pack": "npm run build && npm pack --pack-destination=\"G:\\tarballs\"",
-
+    "publish": "npm run build && npm publish --access public",
     "test": "jest"
   },
   "keywords": [

package/readme.md

@@ -2,6 +2,14 @@
 
 ButlerBot SDK is a JavaScript library that provides a simple way to interact with the [ButlerBot](https://butlerbot.net/) API.
 
+## Quickstart
+
+Grab an API key at [ButlerBot](https://butlerbot.net/) and install the package:
+
+```bash
+npm i @butlerbot/sdk
+```
+
 ## Prerequisites
 
 - ButlerBot API key
@@ -9,7 +17,7 @@ ButlerBot SDK is a JavaScript library that provides a simple way to interact wit
 ## Example
 
 ```typescript
-import { ButlerBotClient } from "butlerbot";
+import { ButlerBotClient } from "@butlerbot/sdk";
 
 const client = new ButlerBotClient({
   apiKey: "your_api_key_here",