@builder.io/ai-utils 0.0.70 → 0.0.71

package/package.json

@@ -1,20 +1,17 @@
 {
   "name": "@builder.io/ai-utils",
-  "version": "0.0.70",
+  "version": "0.0.71",
   "description": "Builder.io AI utils",
   "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "import": "./src/index.js",
+      "types": "./src/index.d.ts"
     }
   },
   "files": [
-    "dist"
-  ],
-  "dependencies": {
-    "@builder.io/sdk": "^2.2.4"
-  }
+    "src"
+  ]
 }

package/{dist → src}/completion.d.ts

@@ -1,5 +1,5 @@
 import type { BuilderContent, BuilderElement, Component } from "@builder.io/sdk";
-import type { Message, MessageParam } from "./messages.js";
+import type { Message, MessageParam, Attachment } from "./messages.js";
 import type { BuilderModel } from "./events.js";
 export type BuilderContentData = BuilderContent["data"];
 export type { BuilderContent, BuilderElement, Component };
@@ -85,6 +85,7 @@ export interface CompletionOptions {
      * Defaults to `persist`
      */
     thread?: "persist" | "ephemeral";
+    attachments?: Attachment[];
 }
 export interface BuilderEditorState {
     /**
@@ -158,4 +159,5 @@ export interface BuilderEditorState {
 export type BuiderEditorState = BuilderEditorState;
 export type OnPromptSubmit = (opts: {
     prompt?: string;
+    attachments: Attachment[];
 }) => void;

package/{dist → src}/events.d.ts

@@ -1,15 +1,15 @@
 import type { BuilderContent, BuilderElement } from "@builder.io/sdk";
-import type { Thread } from "./thread.js";
 import type { AssistantMessage } from "./messages.js";
-import { AssistantSettings } from "./settings.js";
+import type { AssistantSettings } from "./settings.js";
 export type BuilderAssistantEventHandler = (ev: BuilderAssistantEvent) => void;
-export type BuilderAssistantEvent = AssistantCompletionResultEvent | AssistantErrorEvent | AssistantStreamErrorEvent | AppCloseEvent | AppMessagesClickEvent | AppMessagesGenerationEvent | AppMessageEditCustomInstructionsEvent | AppPromptAbortEvent | AppPromptFocusEvent | AppPromptTextEvent | AppReadyEvent | AppSettingsResetEvent | AppSettingsSetEvent | AppThreadNewEvent | AssistantStatsEvent | BuilderEditorAuthEvent | BuilderEditorStateEvent | ContentUpdateEvent | ContentApplySnapshotEvent | ModelCreateEvent | ModelUpdateEvent | ModelUndoEvent | ModelRedoEvent | ResultEvent | ThreadCreatedEvent | ThreadMessageCompletedEvent | ThreadMessageCreatedEvent | ThreadMessageDeltaEvent | ThreadMessageFeedbackEvent | ThreadRunRequiresActionEvent | ThreadRunStepCreatedEvent | ThreadRunStepDeltaEvent | AppAcceptChangeEvent | AppAcceptRejectEvent | AssistantTrackEvent | AssistantEditorAuthMessage;
+export type BuilderAssistantEvent = AssistantCompletionResultEvent | AssistantErrorEvent | AssistantStreamErrorEvent | AppCloseEvent | AppMessagesClickEvent | AppMessagesGenerationEvent | AppMessageEditCustomInstructionsEvent | AppPromptAbortEvent | AppPromptFocusEvent | AppPromptTextEvent | AppReadyEvent | AppSettingsResetEvent | AppSettingsSetEvent | AppThreadNewEvent | AssistantStatsEvent | BuilderEditorAuthEvent | BuilderEditorStateEvent | ContentUpdateEvent | ContentApplySnapshotEvent | ModelCreateEvent | ModelUpdateEvent | ModelUndoEvent | ModelRedoEvent | ResultEvent | ThreadCreatedEvent | ThreadMessageCompletedEvent | ThreadMessageCreatedEvent | ThreadMessageDeltaEvent | ThreadMessageFeedbackEvent | ThreadRunRequiresActionEvent | ThreadRunStepCreatedEvent | ThreadRunStepDeltaEvent | AppAcceptChangeEvent | AppAcceptRejectEvent | AssistantTrackEvent | AssistantEditorAuthMessage | AppAttachmentTemplateEvent;
 export interface AssistantCompletionResultEvent {
     type: "assistant.result";
     data: {
         content?: BuilderContent;
         stats?: AssistantStats;
     };
+    resolveId?: string;
 }
 export interface AssistantError {
     message: string;
@@ -45,6 +45,13 @@ export interface AppAcceptRejectEvent {
 export interface AppMessageEditCustomInstructionsEvent {
     type: "assistant.app.messages.editCustomInstructions";
 }
+export interface AppAttachmentTemplateEvent {
+    type: "assistant.app.attachment.template";
+    data: {
+        id: number;
+        name: string;
+    };
+}
 export interface AppMessagesGenerationEvent {
     type: "assistant.app.messages.generation";
     data: {
@@ -128,26 +135,14 @@ export interface ContentUpdateEvent {
     data: ContentUpdatePatch[];
 }
 export type ContentUpdatePatch = ContentTsCodePatch | ContentInsertBeforePatch | ContentInsertAfterPatch | ContentPropsUpdatePatch | ContentSetChildrenPatch | ContentStyleUpdatePatch | ContentDeletePatch | ContentSetStorePatch | ContentSetMountPatch | ContentMovePatch | ContentMoveAfterPatch | ContentMoveBeforePatch | ContentSetTagNamePatch | ContentTsUpdateComponentPatch;
-export interface NodeData {
-    /**
-     * When dealing with some builder nodes that contain virtual children like Columns, and PersonalizationContainer,
-     * we need to store the virtual child index so we can properly add nodes inside one of the children if needed.
-     */
-    virtualChildIndex?: number;
-}
 interface ContentPatchBase {
     id: string;
+    nodeId?: string;
     builderId?: string;
     description?: string;
-    index: number;
     value: string;
     displayValue?: string;
     ts: number;
-    /**
-     * Any additional data about the patch. For example, this payload could contain the
-     * column index to update when dealing with a Columns component.
-     */
-    data?: NodeData;
     /**
      * A change value is considered incomplete until we also parsed it's closing xml tag.
      */
@@ -277,10 +272,22 @@ export interface AssistantStats {
      * Output tokens
      */
     outputTokens?: number;
+    /**
+     * Output tokens
+     */
+    completionCost?: number;
     /**
      * Number of streamed snapshots
      */
     streamedSnapshots?: number;
+    /**
+     * Number of cached input tokens
+     */
+    cacheInputTokens?: number;
+    /**
+     * Number of cached created tokens
+     */
+    cacheCreatedTokens?: number;
 }
 export interface ModelCreateEvent {
     type: "assistant.model.create";
@@ -318,25 +325,19 @@ export type ModelPatch = {
 };
 export interface ThreadMessageFeedbackEvent {
     type: "assistant.thread.message.feedback";
-    data: ThreadMessageFeedback;
+    data: CompletionResponseFeedback;
 }
-export interface ThreadMessageFeedback {
-    /**
-     * Same as "id" of message
-     */
-    messageId: string;
+export interface CompletionResponseFeedback {
     userId: string;
-    commitId?: string;
-    frontendDomain: string | undefined;
+    builderUserId?: string;
+    builderEmail?: string;
+    responseId?: string;
+    frontendUrl: string | undefined;
     frontendCommitId: string | undefined;
     backendDomain?: string;
     backendCommitId: string | undefined;
     feedbackText: string;
-    thread: Thread;
-    platformId: string;
     sentiment?: "positive" | "negative";
-    builderUserId?: string;
-    builderEmail?: string;
 }
 export interface ThreadCreatedEvent {
     type: "assistant.thread.created";
@@ -353,6 +354,7 @@ export interface ThreadMessageCreatedEvent {
 }
 export interface ThreadMessageCreated {
     id: string;
+    responseId: string;
     threadId: string;
 }
 export interface ThreadMessageDeltaEvent {

package/{dist → src}/messages.d.ts

@@ -1,14 +1,47 @@
-import { ContentUpdatePatch } from "./events.js";
+import type { ContentUpdatePatch } from "./events.js";
 /**
  * Message param does not know the id of the message.
  * This is an input message.
  */
 export type MessageParam = SystemMessageParam | UserMessageParam | AssistantMessageParam;
+export interface ContentMessageItemText {
+    type: "text";
+    text: string;
+    cache?: boolean;
+}
+export interface ContentMessageItemImage {
+    type: "image";
+    source: ImageSource;
+    cache?: boolean;
+}
+export interface ImageSource {
+    type: "base64";
+    media_type: "image/webp" | "image/png" | "image/jpeg";
+    data: string;
+}
+export interface ContentMessageItemThinking {
+    type: "thinking";
+    thinking: string;
+    signature: string;
+}
+export interface ContentMessageItemRedactedThinking {
+    type: "redacted_thinking";
+    data: string;
+}
+export interface ContentMessageItemToolUse {
+    type: "tool_use";
+    id: string;
+    input: unknown;
+    name: string;
+}
+export type ContentMessageItem = ContentMessageItemText | ContentMessageItemImage | ContentMessageItemThinking | ContentMessageItemRedactedThinking | ContentMessageItemToolUse;
+export type ContentMessage = ContentMessageItem[];
 export interface SystemMessageParam {
     /**
      * The contents of the system message.
      */
-    content: string;
+    content: string | ContentMessageItemText[];
+    responseId?: string;
     /**
      * The role of the messages author, in this case `system`.
      */
@@ -19,7 +52,8 @@ export interface UserMessageParam {
     /**
      * The contents of the user message.
      */
-    content: string;
+    content: string | (ContentMessageItemText | ContentMessageItemImage)[];
+    responseId?: string;
     /**
      * The role of the messages author, in this case `user`.
      */
@@ -30,11 +64,12 @@ export interface AssistantMessageParam {
     /**
      * The contents of the assistant message.
      */
-    content?: string;
+    content: string | (ContentMessageItemThinking | ContentMessageItemRedactedThinking | ContentMessageItemText | ContentMessageItemToolUse)[];
     /**
      * The role of the messages author, in this case `assistant`.
      */
     role: "assistant";
+    responseId?: string;
     /**
      * The function call name and arguments
      */
@@ -47,6 +82,7 @@ export interface AssistantMessageParam {
         arguments: any;
     };
     id?: string;
+    skipDelta?: boolean;
     /**
      * A summary of the patches which the assistant has made.
      * Useful for genai.
@@ -62,7 +98,7 @@ export interface UserMessage extends UserMessageParam {
 }
 export interface AssistantMessage extends AssistantMessageParam {
     id: string;
-    status?: "accepted" | "rejected";
+    status?: "accepted" | "rejected" | "aborted";
 }
 export interface AssistantActionMessage {
     /**
@@ -78,3 +114,10 @@ export interface AssistantActionMessage {
  */
 export type Message = SystemMessage | UserMessage | AssistantMessage;
 export type GeneratingMessage = null | Partial<AssistantActionMessage | AssistantMessage>;
+export declare function getContentText(message: string | ContentMessage): string;
+export type Attachment = Template;
+export interface Template {
+    type: "template";
+    name: string;
+    id: number;
+}

package/src/messages.js

@@ -0,0 +1,8 @@
+export function getContentText(message) {
+    if (typeof message === "string") {
+        return message;
+    }
+    return message
+        .map((item) => (item.type === "text" ? item.text : ""))
+        .join("");
+}

package/src/settings.d.ts

@@ -0,0 +1,32 @@
+export interface AssistantSettings {
+    assistantType?: string;
+    viewId?: string;
+    cssOverrides?: string;
+    headingText: string;
+    headingTitle?: string;
+    suggestedPrompts?: SuggestedPrompt[];
+    messagePlaceholder: string;
+    requestAuth?: boolean;
+    requestState?: boolean;
+    showPrompt?: boolean;
+    theme?: "dark" | "light";
+}
+export interface SuggestedPrompt {
+    text: string;
+    type: "modify" | "interactivity" | "data";
+}
+interface IframeSettings extends Partial<AssistantSettings> {
+    local?: boolean;
+    /**
+     * The URL of the assistant.
+     */
+    baseUrl?: string;
+}
+export declare function getAssistantUrl(opts?: IframeSettings): string;
+export declare function parseAssistantUrlSettings(url: string): Partial<AssistantSettings>;
+export interface BuilderEditorAuth {
+    spaceId: string;
+    userId: string;
+    authToken: string;
+}
+export {};

package/{dist → src}/settings.js

@@ -1,22 +1,14 @@
 const urlParamSettings = [
     "assistantType",
-    "hideFrameworkPicker",
-    "hideHeader",
-    "showAiCanMakeMistakes",
-    "showCloseButton",
-    "showHeaderButton",
     "showPrompt",
-    "showSparklesInInputBar",
-    "showUndoButton",
     "requestAuth",
     "requestState",
     "theme",
-    "transparentBackground",
     "viewId",
 ];
 export function getAssistantUrl(opts = {}) {
-    var _a;
-    const url = new URL((_a = opts.baseUrl) !== null && _a !== void 0 ? _a : (opts.local ? "http://localhost:7242" : "https://assistant.builder.io"));
+    const url = new URL(opts.baseUrl ??
+        (opts.local ? "http://localhost:7242" : "https://assistant.builder.io"));
     urlParamSettings.forEach((key) => {
         const value = opts[key];
         if (typeof value === "string" || typeof value === "boolean") {

package/README.md

@@ -1,3 +0,0 @@
-# Builder.io AI types and utilities
-
-Shared types between AI systems, threads, servers, etc.

package/dist/messages.js

@@ -1 +0,0 @@
-export {};

package/dist/settings.d.ts

@@ -1,65 +0,0 @@
-export interface AssistantSettings {
-    assistantType?: string;
-    viewId?: string;
-    cssOverrides?: string;
-    headingText: string;
-    headingTitle?: string;
-    headingImage?: string;
-    suggestedPrompts?: SuggestedPrompt[];
-    hideNewChatIfNoMessages?: boolean;
-    hideFrameworkPicker?: boolean;
-    hideHeader?: boolean;
-    messagePlaceholder: string;
-    requestAuth?: boolean;
-    requestState?: boolean;
-    showAiCanMakeMistakes?: boolean;
-    showCloseButton?: boolean;
-    showHeaderButton?: boolean;
-    showPrompt?: boolean;
-    showSparklesInInputBar?: boolean;
-    /**
-     * Show the undo button under the assistant's message.
-     */
-    showUndoButton?: boolean;
-    suggestedItems: Snippet[];
-    theme?: "dark" | "light";
-    transparentBackground?: boolean;
-}
-export interface SuggestedPrompt {
-    text: string;
-    type: "modify" | "interactivity" | "data";
-}
-export interface Snippet {
-    /**
-     * The text that will be displayed in the chat snippet button.
-     */
-    text: string;
-    /**
-     * The icon that will be displayed in the chat snippet button.
-     */
-    icon?: string;
-    /**
-     * The color of the icon that will be displayed in the chat snippet button.
-     */
-    iconColor?: string;
-    /**
-     * The prompt text that will be sent to the assistant when the user clicks the chat snippet button.
-     * This prompt is also what's added to the chat conversation from the user.
-     */
-    prompt?: string;
-}
-interface IframeSettings extends Partial<AssistantSettings> {
-    local?: boolean;
-    /**
-     * The URL of the assistant.
-     */
-    baseUrl?: string;
-}
-export declare function getAssistantUrl(opts?: IframeSettings): string;
-export declare function parseAssistantUrlSettings(url: string): Partial<AssistantSettings>;
-export interface BuilderEditorAuth {
-    spaceId: string;
-    userId: string;
-    authToken: string;
-}
-export {};