@butlerbot/sdk 0.0.4 → 0.0.6-alpha.0

package/dist/config.d.ts

@@ -6,6 +6,9 @@ export declare const CONFIG: {
             v3: {
                 base: string;
             };
+            v4: {
+                base: string;
+            };
         };
     };
 };

package/dist/config.js

@@ -6,7 +6,8 @@ exports.CONFIG = {
     healthcheckPath: "/api/healthcheck",
     paths: {
         conversation: {
-            v3: { base: "/api/alfred/v3/chat" }
+            v3: { base: "/api/alfred/v3/chat" },
+            v4: { base: "/api/alfred/v4/chat" },
         }
     }
 };

package/dist/modules/conversation.d.ts

@@ -1,4 +1,5 @@
-import { RequestResponse } from "../types/dialogue_response_v3";
+import { CONFIG } from "../config";
+import { RequestResponseV3 } from "../types/type_registry";
 export type DialogueRequestParams = {
     /** Unique identifier for the chat session */
     chatId?: string;
@@ -14,6 +15,7 @@ export type DialogueRequestParams = {
     personality?: string;
 };
 export type DialogueRequestOptions = Omit<Omit<DialogueRequestParams, "message">, "chatId">;
+type APIPath = keyof typeof CONFIG.paths.conversation;
 export type ConversationOptions = {
     /** The conversation ID to load the conversation from, server will error if this convo id doesn't exist */
     convoId?: string;
@@ -25,7 +27,10 @@ export type ConversationOptions = {
     path?: string;
     /** Whether to enable debug logs */
     debug?: boolean;
+    /** The API version to use */
+    api?: APIPath;
 };
+export type RequestResponse = RequestResponseV3;
 export declare class Conversation {
     convoId?: string;
     apiKey: string;
@@ -60,3 +65,4 @@ export declare class Conversation {
     /** Sends a message into the conversation */
     send(message: string, cb: (chunk: RequestResponse) => any, options?: DialogueRequestOptions): Promise<void>;
 }
+export {};

package/dist/modules/conversation.js

@@ -12,10 +12,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Conversation = void 0;
 const eventsource_1 = require("eventsource");
 const config_1 = require("../config");
+const DEFAULT_API = "v3";
 class Conversation {
     constructor(config) {
         this.convoId = config.convoId;
-        this.endpoint = (config.serverUrl || config_1.CONFIG.server) + (config.path || config_1.CONFIG.paths.conversation.v3.base);
+        this.endpoint = (config.serverUrl || config_1.CONFIG.server) + (config.path || config_1.CONFIG.paths.conversation[config.api || DEFAULT_API].base);
         this.apiKey = config.apiKey;
         this.debug = config.debug || false;
     }

package/dist/types/ai_response_v3.d.ts

@@ -40,6 +40,19 @@ type AIMessageResponse = {
         display?: AIChatProfileDisplayEntity;
     };
 };
+export type AIReasoningResponse = {
+    /** Specifies type to be a reasoning update */
+    type: "reasoning";
+    payload: {
+        /** The reasoning text */
+        reasoning: string;
+        /** The associated reasoning id */
+        reasoningId: string;
+        /** Whether this reasoning step is completed */
+        completed: boolean;
+    };
+    metadata: BaseAIResponseMetadata;
+};
 export type AIFileResponse = {
     /** Specifies type to be a message */
     type: "file";
@@ -84,5 +97,5 @@ export type AIToolResponse = {
     };
     metadata: BaseAIResponseMetadata & {};
 };
-export type AIResponse = AIMessageResponse | AIToolResponse | AIConvoStatusResponse | AIResponseStatusResponse | AIFileResponse;
+export type AIResponse = AIMessageResponse | AIToolResponse | AIConvoStatusResponse | AIResponseStatusResponse | AIFileResponse | AIReasoningResponse;
 export {};

package/dist/types/type_registry.d.ts

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

package/dist/types/type_registry.js

@@ -14,7 +14,6 @@ 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("./v3"), exports);
+__exportStar(require("./v4"), exports);
 __exportStar(require("./error"), exports);
-__exportStar(require("./ai_tools_v3"), exports);

package/dist/types/v3/ai_response_v3.d.ts

@@ -0,0 +1,101 @@
+import { AIToolStatusDataV3 } from "./ai_tools_v3";
+import { ErrorCode } from "../error";
+export type AIChatResultFailV3 = {
+    success: false;
+    errorcode: ErrorCode;
+};
+export type AIChatResultSuccessV3 = {
+    success: true;
+    response: AIResponseV3[];
+    usage: any;
+};
+export type AIChatResultV3 = AIChatResultFailV3 | AIChatResultSuccessV3;
+type AIChatProfileDisplayEntity = {
+    name?: string;
+    avatarUrl?: string;
+};
+export type BaseAIResponseMetadataV3 = {
+    /** The model that generated this message */
+    model: string;
+    /** The actual model ID that generated this message */
+    modelId: string;
+    /** 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;
+};
+type AIMessageResponseV3 = {
+    /** Specifies type to be a message */
+    type: "message";
+    payload: {
+        /** Message to send to the user */
+        message: string;
+        /** The associated message id */
+        messageId: string;
+        /** Whether this message was completed */
+        completed: boolean;
+    };
+    metadata: BaseAIResponseMetadataV3 & {
+        /** Display data for this message response, such as the author's name and profile picture */
+        display?: AIChatProfileDisplayEntity;
+    };
+};
+export type AIReasoningResponseV3 = {
+    /** Specifies type to be a reasoning update */
+    type: "reasoning";
+    payload: {
+        /** The reasoning text */
+        reasoning: string;
+        /** The associated reasoning id */
+        reasoningId: string;
+        /** Whether this reasoning step is completed */
+        completed: boolean;
+    };
+    metadata: BaseAIResponseMetadataV3;
+};
+export type AIFileResponseV3 = {
+    /** 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: BaseAIResponseMetadataV3 & {
+        /** Display data for this message response, such as the author's name and profile picture */
+        display?: AIChatProfileDisplayEntity;
+    };
+};
+export type AIResponseStatusResponseV3 = {
+    /** Specifies type to be a status update for the response */
+    type: "response_status";
+    payload: {
+        /** Whether the entire AI response is completed */
+        completed: boolean;
+    };
+};
+export type AIConvoStatusResponseV3 = {
+    /** Specifies type to be a status update for the conversation */
+    type: "convo_status";
+    payload: {
+        /** Whether the entire AI convo has been disabled, a disabled convo cannot be restarted */
+        disabled: boolean;
+        /** Whether the AI convo has been stopped, a stopped convo can be restarted
+         * although just because it's not stopped does not necasserily mean it's an ongoing conversation */
+        stopped: boolean;
+    };
+};
+export type AIToolResponseV3 = {
+    /** Specifies type to be a tool use status update */
+    type: "tool";
+    payload: {
+        status: string;
+        info: AIToolStatusDataV3;
+    };
+    metadata: BaseAIResponseMetadataV3 & {};
+};
+export type AIResponseV3 = AIMessageResponseV3 | AIToolResponseV3 | AIConvoStatusResponseV3 | AIResponseStatusResponseV3 | AIFileResponseV3 | AIReasoningResponseV3;
+export {};

package/dist/types/v3/ai_response_v3.js

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

package/dist/types/v3/ai_tools_v3.d.ts

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

package/dist/types/v3/ai_tools_v3.js

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

package/dist/types/v3/dialogue_response_v3.d.ts

@@ -0,0 +1,29 @@
+import { AIResponseV3 } from "./ai_response_v3";
+import { ErrorCode } from "../error";
+export type RequestBaseResponsePayloadV3 = {
+    /** Whether the conversation's ending */
+    end?: boolean;
+    /** Whether the stream is ending */
+    quitStream?: boolean;
+};
+export type RequestFailResponseV3 = {
+    success: false;
+    data: {
+        /** Error code */
+        code: ErrorCode;
+        /** Error message */
+        error: string;
+        /** User facing message */
+        message: string;
+    } & RequestBaseResponsePayloadV3;
+};
+export type RequestSuccessResponseV3 = {
+    success: true;
+    data: {
+        /** The AI's response */
+        response: AIResponseV3;
+        /** The convoId, passed in most responses */
+        convoId?: string;
+    } & RequestBaseResponsePayloadV3;
+};
+export type RequestResponseV3 = RequestFailResponseV3 | RequestSuccessResponseV3;

package/dist/types/v3/dialogue_response_v3.js

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

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

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

package/dist/types/v3/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("./ai_response_v3"), exports);
+__exportStar(require("./dialogue_response_v3"), exports);
+__exportStar(require("./ai_tools_v3"), exports);

package/dist/types/v4/ai_response_v4.d.ts

@@ -0,0 +1,145 @@
+import { AIToolStatusDataV4 } from "./ai_tools_v4";
+import { ErrorCode } from "../error";
+export type AIChatResultFailV4 = {
+    success: false;
+    errorcode: ErrorCode;
+};
+export type AIChatResultSuccessV4 = {
+    success: true;
+    response: AIResponseV4[];
+    usage: any;
+};
+export type AIChatResultV4 = AIChatResultFailV4 | AIChatResultSuccessV4;
+type AIChatProfileDisplayEntity = {
+    name?: string;
+    avatarUrl?: string;
+};
+export type BaseAIResponseMetadataV4 = {
+    /** The model that generated this message */
+    model: string;
+    /** The actual model ID that generated this message */
+    modelId: string;
+    /** 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;
+};
+/** Response Metadata */
+export type ResponseStatusMetadataV4 = {
+    /** Human-readable model name (e.g. "Claude-Sonnet") */
+    model: string;
+    /** Provider model identifier (e.g. "claude-sonnet-4-6") */
+    modelId: string;
+    /** Token usage breakdown */
+    tokens: {
+        input: number;
+        output: number;
+        total: number;
+        cachedInput: number;
+        reasoningOutput: number;
+    };
+    /** Usage budget info */
+    usage: {
+        /** Current usage cost as a percentage of daily limit (0–1) */
+        percentage: number;
+        /** Human-readable percentage (e.g. "42.3%") */
+        percentageDisplay: string;
+        /** Name of the active usage stage */
+        stageName: string;
+    };
+    /** Model switching info (tiered auto-downgrade) */
+    modelSwitching: {
+        /** Whether the model was switched from the user's request */
+        switched: boolean;
+        /** Originally requested model */
+        requestedModel: string;
+        /** Model that was actually used */
+        activeModel: string;
+        /** Usage stage that triggered the switch */
+        stage?: string;
+    };
+    /** Response timing */
+    timing: {
+        /** Milliseconds from request start to first streamed event */
+        firstEventMs: number;
+        /** Total response time in milliseconds */
+        totalMs: number;
+    };
+};
+type AIMessageResponseV4 = {
+    /** Specifies type to be a message */
+    type: "message";
+    payload: {
+        /** Message to send to the user */
+        message: string;
+        /** The associated message id */
+        messageId: string;
+        /** Whether this message was completed */
+        completed: boolean;
+    };
+    metadata: BaseAIResponseMetadataV4 & {
+        /** Display data for this message response, such as the author's name and profile picture */
+        display?: AIChatProfileDisplayEntity;
+    };
+};
+export type AIReasoningResponseV4 = {
+    /** Specifies type to be a reasoning update */
+    type: "reasoning";
+    payload: {
+        /** The reasoning text */
+        reasoning: string;
+        /** The associated reasoning id */
+        reasoningId: string;
+        /** Whether this reasoning step is completed */
+        completed: boolean;
+    };
+    metadata: BaseAIResponseMetadataV4;
+};
+export type AIFileResponseV4 = {
+    /** 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: BaseAIResponseMetadataV4 & {
+        /** Display data for this message response, such as the author's name and profile picture */
+        display?: AIChatProfileDisplayEntity;
+    };
+};
+export type AIResponseStatusResponseV4 = {
+    /** Specifies type to be a status update for the response */
+    type: "response_status";
+    payload: {
+        /** Whether the entire AI response is completed */
+        completed: boolean;
+        /** Response status metadata on success */
+        metadata?: ResponseStatusMetadataV4;
+    };
+};
+export type AIConvoStatusResponseV4 = {
+    /** Specifies type to be a status update for the conversation */
+    type: "convo_status";
+    payload: {
+        /** Whether the entire AI convo has been disabled, a disabled convo cannot be restarted */
+        disabled: boolean;
+        /** Whether the AI convo has been stopped, a stopped convo can be restarted
+         * although just because it's not stopped does not necasserily mean it's an ongoing conversation */
+        stopped: boolean;
+    };
+};
+export type AIToolResponseV4 = {
+    /** Specifies type to be a tool use status update */
+    type: "tool";
+    payload: {
+        status: string;
+        info: AIToolStatusDataV4;
+    };
+    metadata: BaseAIResponseMetadataV4 & {};
+};
+export type AIResponseV4 = AIMessageResponseV4 | AIToolResponseV4 | AIConvoStatusResponseV4 | AIResponseStatusResponseV4 | AIFileResponseV4 | AIReasoningResponseV4;
+export {};

package/dist/types/v4/ai_response_v4.js

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

package/dist/types/v4/ai_tools_v4.d.ts

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

package/dist/types/v4/ai_tools_v4.js

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

package/dist/types/v4/dialogue_response_v4.d.ts

@@ -0,0 +1,29 @@
+import { AIResponseV4 } from "./ai_response_v4";
+import { ErrorCode } from "../error";
+export type RequestBaseResponsePayloadV4 = {
+    /** Whether the conversation's ending */
+    end?: boolean;
+    /** Whether the stream is ending */
+    quitStream?: boolean;
+};
+export type RequestFailResponseV4 = {
+    success: false;
+    data: {
+        /** Error code */
+        code: ErrorCode;
+        /** Error message */
+        error: string;
+        /** User facing message */
+        message: string;
+    } & RequestBaseResponsePayloadV4;
+};
+export type RequestSuccessResponseV4 = {
+    success: true;
+    data: {
+        /** The AI's response */
+        response: AIResponseV4;
+        /** The convoId, passed in most responses */
+        convoId?: string;
+    } & RequestBaseResponsePayloadV4;
+};
+export type RequestResponseV4 = RequestFailResponseV4 | RequestSuccessResponseV4;

package/dist/types/v4/dialogue_response_v4.js

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

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

@@ -0,0 +1,3 @@
+export * from "./ai_response_v4";
+export * from "./dialogue_response_v4";
+export * from "./ai_tools_v4";

package/dist/types/v4/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("./ai_response_v4"), exports);
+__exportStar(require("./dialogue_response_v4"), exports);
+__exportStar(require("./ai_tools_v4"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@butlerbot/sdk",
-	"version": "0.0.4",
+	"version": "0.0.6-alpha.0",
 	"description": "The official ButlerBot SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -11,6 +11,7 @@
 		"build": "tsc",
 		"pack": "npm run build && npm pack --pack-destination=\"G:\\tarballs\"",
 		"update": "npm run build && npm publish --access public",
+		"update:alpha": "npm run build && npm publish --access public --tag alpha",
 		"test": "jest"
 	},
 	"keywords": [