@builder.io/ai-utils 0.0.26 → 0.0.28

package/dist/completion.d.ts

@@ -42,7 +42,7 @@ export interface CompletionOptions {
     /**
      * The state of the builder editor.
      */
-    builderState?: BuiderEditorState;
+    builderState?: BuilderEditorState;
     /**
      * Persist the thread conversation context.
      * Defaults to `true`.
@@ -58,7 +58,7 @@ export interface CompletionOptions {
      */
     startMs?: number;
 }
-export interface BuiderEditorState {
+export interface BuilderEditorState {
     /**
      * The active locale of the builder editor.
      */
@@ -108,6 +108,10 @@ export interface BuiderEditorState {
      */
     sessionId?: string;
 }
+/**
+ * @deprecated Uggh, spelling is hard. Use `BuilderEditorState` instead.
+ */
+export type BuiderEditorState = BuilderEditorState;
 export type OnPromptSubmit = (opts: {
     prompt?: string;
     snippetId?: string;

package/dist/events.d.ts

@@ -3,7 +3,7 @@ import type { Thread } from "./thread";
 import type { AssistantMessage } from "./messages";
 import { AssistantSettings } from "./settings";
 export type BuilderAssistantEventHandler = (ev: BuilderAssistantEvent) => void;
-export type BuilderAssistantEvent = AssistantErrorEvent | AppCloseEvent | AppMessagesClickEvent | AppMessagesGenerationEvent | AppPromptAbortEvent | AppPromptFocusEvent | AppPromptTextEvent | AppReadyEvent | AppSettingsResetEvent | AppSettingsSetEvent | AppThreadNewEvent | BuiderEditorStateEvent | ContentUpdateEvent | ContentApplySnapshotEvent | ContentCompleteEvent | ModelCreateEvent | ModelUpdateEvent | ModelUndoEvent | ResultEvent | ThreadCreatedEvent | ThreadMessageDeltaEvent | ThreadMessageCompletedEvent | ThreadMessageFeedbackEvent | ThreadRunRequiresActionEvent | ThreadRunStepCreatedEvent | ThreadRunStepDeltaEvent;
+export type BuilderAssistantEvent = AssistantErrorEvent | AppCloseEvent | AppMessagesClickEvent | AppMessagesGenerationEvent | AppPromptAbortEvent | AppPromptFocusEvent | AppPromptTextEvent | AppReadyEvent | AppSettingsResetEvent | AppSettingsSetEvent | AppThreadNewEvent | BuilderEditorStateEvent | ContentUpdateEvent | ContentApplySnapshotEvent | ContentCompleteEvent | ModelCreateEvent | ModelUpdateEvent | ModelUndoEvent | ResultEvent | ThreadCreatedEvent | ThreadMessageDeltaEvent | ThreadMessageCompletedEvent | ThreadMessageFeedbackEvent | ThreadRunRequiresActionEvent | ThreadRunStepCreatedEvent | ThreadRunStepDeltaEvent;
 export interface AssistantError {
     message: string;
     status?: number;
@@ -56,9 +56,13 @@ export interface AppSettingsSetEvent {
 export interface AppThreadNewEvent {
     type: "assistant.app.thread.new";
 }
-export interface BuiderEditorStateEvent extends AwaitResultEvent {
+export interface BuilderEditorStateEvent extends AwaitResultEvent {
     type: "assistant.editor.state";
 }
+/**
+ * @deprecated Use BuilderEditorStateEvent
+ */
+export type BuiderEditorStateEvent = BuilderEditorStateEvent;
 export interface AwaitResultEvent {
     resolveId?: string;
 }
@@ -94,11 +98,23 @@ export interface ContentUpdateEvent {
     data: ContentUpdatePatch[];
 }
 export type ContentUpdatePatch = ContentInsertBeforePatch | ContentInsertAfterPatch | ContentPropsUpdatePatch | ContentSetChildrenPatch | ContentStyleUpdatePatch;
+export interface NodeData {
+    /**
+     * When dealing with column nodes we need to store the column index so
+     * we can properly add nodes inside of a column if needed.
+     */
+    columnIndex?: number;
+}
 interface ContentPatchBase {
     id: string;
     index: number;
     value: 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;
 }
 export interface ContentInsertBeforePatch extends ContentPatchBase {
     type: "insert_before";
@@ -171,6 +187,8 @@ export interface ThreadMessageFeedback {
     thread: Thread;
     platformId: string;
     sentiment?: "positive" | "negative";
+    builderUserId?: string;
+    builderEmail?: string;
 }
 export interface ThreadCreatedEvent {
     type: "assistant.thread.created";

package/dist/settings.d.ts

@@ -1,6 +1,7 @@
 import type { SnippetParams } from "./messages";
 export interface AssistantSettings {
     assistantType?: string;
+    viewId?: string;
     cssOverrides?: string;
     headingText: string;
     hideFrameworkPicker?: boolean;
@@ -12,6 +13,10 @@ export interface AssistantSettings {
     showHeaderButton?: boolean;
     showPrompt?: boolean;
     showSparklesInInputBar?: boolean;
+    /**
+     * Show the undo button under the assistant's message.
+     */
+    showUndoButton?: boolean;
     suggestedItems: Snippet[];
     theme?: "dark" | "light";
     transparentBackground?: boolean;

package/dist/settings.js

@@ -7,9 +7,11 @@ const urlParamSettings = [
     "showHeaderButton",
     "showPrompt",
     "showSparklesInInputBar",
+    "showUndoButton",
     "requestState",
     "theme",
     "transparentBackground",
+    "viewId",
 ];
 export function getAssistantUrl(opts = {}) {
     const url = new URL(opts.local

package/dist/thread.d.ts

@@ -11,7 +11,17 @@ export interface Thread {
     threadId?: string;
     platformId?: string;
     title?: string;
+    /**
+     * The type of assistant that the thread is associated with.
+     * For example, "content-editor" or "docs".
+     */
     assistantType?: string;
+    /**
+     * The unique identifier of the view that the thread is associated with.
+     * For example, the "content-editor" assistant would use the
+     * builder content id as the viewId.
+     */
+    viewId?: string;
     created: number;
     messages: Message[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@builder.io/ai-utils",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "description": "Builder.io AI utils",
   "type": "module",
   "main": "dist/index.js",