@butlerbot/sdk 0.0.3 → 0.0.4

package/dist/types/ai_response_v3.d.ts

@@ -10,15 +10,21 @@ export type AIChatResultSuccess = {
     usage: any;
 };
 export type AIChatResult = AIChatResultFail | AIChatResultSuccess;
+type AIChatProfileDisplayEntity = {
+    name?: string;
+    avatarUrl?: string;
+};
 export type BaseAIResponseMetadata = {
     /** The model that generated this message */
     model: string;
     /** The actual model ID that generated this message */
     modelId: string;
-    /** Epoch time for when this happened */
+    /** The time when this action started (represents time of first action, meaning in streamed messages it'll hold the time the first chunk was sent) */
+    firstTimestamp: number;
+    /** Epoch time for when this happened (represents time of last action, meaning in streamed messages it'll hold the time the last chunk was sent) */
     timestamp: number;
 };
-export type AIMessageResponse = {
+type AIMessageResponse = {
     /** Specifies type to be a message */
     type: "message";
     payload: {
@@ -29,7 +35,26 @@ export type AIMessageResponse = {
         /** Whether this message was completed */
         completed: boolean;
     };
-    metadata: BaseAIResponseMetadata & {};
+    metadata: BaseAIResponseMetadata & {
+        /** Display data for this message response, such as the author's name and profile picture */
+        display?: AIChatProfileDisplayEntity;
+    };
+};
+export type AIFileResponse = {
+    /** Specifies type to be a message */
+    type: "file";
+    payload: {
+        /** URL location of the file */
+        url?: string;
+        /** Base64 representation of the file */
+        base64?: string;
+        /** The media type of the file */
+        mediaType: string;
+    };
+    metadata: BaseAIResponseMetadata & {
+        /** Display data for this message response, such as the author's name and profile picture */
+        display?: AIChatProfileDisplayEntity;
+    };
 };
 export type AIResponseStatusResponse = {
     /** Specifies type to be a status update for the response */
@@ -59,4 +84,5 @@ export type AIToolResponse = {
     };
     metadata: BaseAIResponseMetadata & {};
 };
-export type AIResponse = AIMessageResponse | AIToolResponse | AIConvoStatusResponse | AIResponseStatusResponse;
+export type AIResponse = AIMessageResponse | AIToolResponse | AIConvoStatusResponse | AIResponseStatusResponse | AIFileResponse;
+export {};

package/package.json

@@ -1,44 +1,44 @@
 {
-  "name": "@butlerbot/sdk",
-  "version": "0.0.3",
-  "description": "The official ButlerBot SDK",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist/**/*"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "pack": "npm run build && npm pack --pack-destination=\"G:\\tarballs\"",
-    "update": "npm run build && npm publish --access public",
-    "test": "jest"
-  },
-  "keywords": [
-    "butlerbot",
-    "alfred",
-    "sdk",
-    "chatbot",
-    "ai",
-    "butler"
-  ],
-  "author": "Fragly",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/isdevco/alfred5_sdk.git"
-  },
-  "bugs": {
-    "url": "https://github.com/isdevco/alfred5_sdk/issues"
-  },
-  "homepage": "https://butlerbot.net",
-  "engines": {
-    "node": ">=14.0.0"
-  },
-  "devDependencies": {
-    "@types/node": "^22.13.10",
-    "typescript": "^5.8.2"
-  },
-  "dependencies": {
-    "eventsource": "^3.0.5"
-  }
-}
+	"name": "@butlerbot/sdk",
+	"version": "0.0.4",
+	"description": "The official ButlerBot SDK",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"files": [
+		"dist/**/*"
+	],
+	"scripts": {
+		"build": "tsc",
+		"pack": "npm run build && npm pack --pack-destination=\"G:\\tarballs\"",
+		"update": "npm run build && npm publish --access public",
+		"test": "jest"
+	},
+	"keywords": [
+		"butlerbot",
+		"alfred",
+		"sdk",
+		"chatbot",
+		"ai",
+		"butler"
+	],
+	"author": "Fragly",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/isdevco/alfred5_sdk.git"
+	},
+	"bugs": {
+		"url": "https://github.com/isdevco/alfred5_sdk/issues"
+	},
+	"homepage": "https://butlerbot.net",
+	"engines": {
+		"node": ">=14.0.0"
+	},
+	"devDependencies": {
+		"@types/node": "^22.13.10",
+		"typescript": "^5.8.2"
+	},
+	"dependencies": {
+		"eventsource": "^3.0.5"
+	}
+}

package/readme.md

@@ -10,6 +10,8 @@ Grab an API key at [ButlerBot](https://butlerbot.net/) and install the package:
 npm i @butlerbot/sdk
 ```
 
+> NOTE: API key is currently not available on the ButlerBot UI
+
 ## Prerequisites
 
 - ButlerBot API key