@builder.io/ai-utils 0.18.0 → 0.18.2

package/src/events.d.ts

@@ -2,139 +2,92 @@ import type { BuilderContent, BuilderElement } from "@builder.io/sdk";
 import type { AssistantMessage, AssistantMessageAction } from "./messages.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
-	| AppPromptSubmitEvent
-	| AppReadyEvent
-	| AppSettingsSetEvent
-	| AppThreadNewEvent
-	| AssistantStatsEvent
-	| AssistantThemeEvent
-	| BuilderEditorAuthEvent
-	| BuilderEditorStateEvent
-	| ContentUpdateEvent
-	| ContentApplySnapshotEvent
-	| ModelUndoEvent
-	| ModelRedoEvent
-	| ResultEvent
-	| ThreadCreatedEvent
-	| ThreadMessageCompletedEvent
-	| ThreadMessageCreatedEvent
-	| ThreadMessageDeltaEvent
-	| ThreadMessageFeedbackEvent
-	| ThreadRunStepCreatedEvent
-	| ThreadRunStepDeltaEvent
-	| AppAcceptChangeEvent
-	| AppAcceptRejectEvent
-	| AssistantTrackEvent
-	| AssistantEditorAuthMessage
-	| AppAttachmentTemplateEvent
-	| AppPasteSmartExportEvent
-	| ThreadMessageRetryEvent
-	| AppFigmaImportEvent
-	| AppWebImportEvent
-	| AppMcpServersEvent
-	| AssistantContentInitialEvent
-	| ThreadMessageSummaryEvent
-	| ThreadMessageSummaryCodegenDeltaEvent
-	| ThreadMessageThinkingDeltaEvent
-	| AssistantHeartbeatEvent
-	| ShowUpgradeDialogEvent
-	| AssistantFusionSuggestionEvent
-	| AppNavigateToFusionEvent;
+export type BuilderAssistantEvent = AssistantCompletionResultEvent | AssistantErrorEvent | AssistantStreamErrorEvent | AppCloseEvent | AppMessagesClickEvent | AppMessagesGenerationEvent | AppMessageEditCustomInstructionsEvent | AppPromptAbortEvent | AppPromptFocusEvent | AppPromptSubmitEvent | AppReadyEvent | AppSettingsSetEvent | AppThreadNewEvent | AssistantStatsEvent | AssistantThemeEvent | BuilderEditorAuthEvent | BuilderEditorStateEvent | ContentUpdateEvent | ContentApplySnapshotEvent | ModelUndoEvent | ModelRedoEvent | ResultEvent | ThreadCreatedEvent | ThreadMessageCompletedEvent | ThreadMessageCreatedEvent | ThreadMessageDeltaEvent | ThreadMessageFeedbackEvent | ThreadRunStepCreatedEvent | ThreadRunStepDeltaEvent | AppAcceptChangeEvent | AppAcceptRejectEvent | AssistantTrackEvent | AssistantEditorAuthMessage | AppAttachmentTemplateEvent | AppPasteSmartExportEvent | ThreadMessageRetryEvent | AppFigmaImportEvent | AppWebImportEvent | AppMcpServersEvent | AssistantContentInitialEvent | ThreadMessageSummaryEvent | ThreadMessageSummaryCodegenDeltaEvent | ThreadMessageThinkingDeltaEvent | AssistantHeartbeatEvent | ShowUpgradeDialogEvent | AssistantFusionSuggestionEvent | AppNavigateToFusionEvent;
 export interface AssistantCompletionResultEvent {
-	type: "assistant.result";
-	data: {
-		content?: BuilderContent;
-		stats?: AssistantStats;
-	};
-	resolveId?: string;
+    type: "assistant.result";
+    data: {
+        content?: BuilderContent;
+        stats?: AssistantStats;
+    };
+    resolveId?: string;
 }
 export interface AssistantError {
-	message: string;
-	status?: number;
-	actions?: AssistantMessageAction[];
+    message: string;
+    status?: number;
+    actions?: AssistantMessageAction[];
 }
 export interface AssistantErrorEvent {
-	type: "assistant.error";
-	data: AssistantError;
+    type: "assistant.error";
+    data: AssistantError;
 }
 export interface AssistantStreamErrorEvent {
-	type: "assistant.stream.error";
-	data: AssistantError;
+    type: "assistant.stream.error";
+    data: AssistantError;
 }
 export interface AppFigmaImportEvent {
-	type: "assistant.app.figmaImport";
+    type: "assistant.app.figmaImport";
 }
 export interface AppWebImportEvent {
-	type: "assistant.app.webImport";
+    type: "assistant.app.webImport";
 }
 export interface AppMcpServersEvent {
-	type: "assistant.app.mcpServers";
+    type: "assistant.app.mcpServers";
 }
 export interface AppNavigateToFusionEvent {
-	type: "assistant.app.navigateToFusion";
+    type: "assistant.app.navigateToFusion";
 }
 export interface AssistantTrackEvent {
-	type: "assistant.track";
-	data: {
-		name: string;
-		properties: Record<string, any>;
-	};
+    type: "assistant.track";
+    data: {
+        name: string;
+        properties: Record<string, any>;
+    };
 }
 export interface AssistantThemeEvent {
-	type: "assistant.app.theme.update";
-	data: {
-		theme: string;
-	};
+    type: "assistant.app.theme.update";
+    data: {
+        theme: string;
+    };
 }
 export interface AppCloseEvent {
-	type: "assistant.app.close";
+    type: "assistant.app.close";
 }
 export interface AppMessagesClickEvent {
-	type: "assistant.app.messages.click";
+    type: "assistant.app.messages.click";
 }
 export interface ShowUpgradeDialogEvent {
-	type: "assistant.app.showUpgradeDialog";
+    type: "assistant.app.showUpgradeDialog";
 }
 export interface AppAcceptChangeEvent {
-	type: "assistant.app.change.accept";
+    type: "assistant.app.change.accept";
 }
 export interface AppAcceptRejectEvent {
-	type: "assistant.app.change.reject";
+    type: "assistant.app.change.reject";
 }
 export interface AppMessageEditCustomInstructionsEvent {
-	type: "assistant.app.messages.editCustomInstructions";
-	data: {
-		hasChatMessages: boolean;
-	};
+    type: "assistant.app.messages.editCustomInstructions";
+    data: {
+        hasChatMessages: boolean;
+    };
 }
 export interface AppAttachmentTemplateEvent {
-	type: "assistant.app.attachment.template";
-	data: {
-		id: number;
-		name: string;
-	};
+    type: "assistant.app.attachment.template";
+    data: {
+        id: number;
+        name: string;
+    };
 }
 export interface AppPasteSmartExportEvent {
-	type: "assistant.app.paste.smartExport";
-	data: {
-		clipboardText: string;
-	};
+    type: "assistant.app.paste.smartExport";
+    data: {
+        clipboardText: string;
+    };
 }
 export interface AppMessagesGenerationEvent {
-	type: "assistant.app.messages.generation";
-	data: {
-		state: GenerationState;
-	};
+    type: "assistant.app.messages.generation";
+    data: {
+        state: GenerationState;
+    };
 }
 /**
  * idle: no messages are being generated or queued to be generated
@@ -145,330 +98,325 @@ export interface AppMessagesGenerationEvent {
  */
 export type GenerationState = "idle" | "queued" | "generating";
 export interface AppPromptAbortEvent {
-	type: "assistant.app.prompt.abort";
+    type: "assistant.app.prompt.abort";
 }
 export interface AppPromptFocusEvent {
-	type: "assistant.app.prompt.focus";
+    type: "assistant.app.prompt.focus";
 }
 export interface AppPromptSubmitEvent {
-	type: "assistant.app.prompt.submit";
-	data: {
-		prompt: string;
-		attachments: any[];
-	};
+    type: "assistant.app.prompt.submit";
+    data: {
+        prompt: string;
+        attachments: any[];
+    };
 }
 export interface AppReadyEvent {
-	type: "assistant.app.ready";
+    type: "assistant.app.ready";
 }
 export interface AppSettingsSetEvent {
-	type: "assistant.app.settings.set";
-	data: Partial<AssistantSettings>;
+    type: "assistant.app.settings.set";
+    data: Partial<AssistantSettings>;
 }
 export interface AppThreadNewEvent {
-	type: "assistant.app.thread.new";
+    type: "assistant.app.thread.new";
 }
 export interface AssistantEditorAuthMessage {
-	type: "assistant.editor.auth.update";
+    type: "assistant.editor.auth.update";
 }
 export interface BuilderEditorAuthEvent extends AwaitResultEvent {
-	type: "assistant.editor.auth";
+    type: "assistant.editor.auth";
 }
 export interface BuilderEditorStateEvent extends AwaitResultEvent {
-	type: "assistant.editor.state";
+    type: "assistant.editor.state";
 }
 export interface AwaitResultEvent {
-	resolveId?: string;
+    resolveId?: string;
 }
 export interface ResultEvent {
-	type: "assistant.result";
-	resolveId: string;
-	data: any;
+    type: "assistant.result";
+    resolveId: string;
+    data: any;
 }
 export interface ContentCreatePatch {
-	parentId: string;
-	insertBeforeId: string;
-	element: BuilderElement;
+    parentId: string;
+    insertBeforeId: string;
+    element: BuilderElement;
 }
 export interface ContentApplySnapshot {
-	/**
-	 * The id of the BuilderContent to apply the snapshot to
-	 */
-	id: string;
-	/**
-	 * Each snapshot can be either a full BuilderContent or individual BuilderElements.
-	 * Order matters, as the snapshots will be applied in the order they are listed.
-	 * The builder app will handle the logic of applying the snapshots in the correct order
-	 * and to the right content/elements.
-	 */
-	snapshots: (BuilderElement | BuilderContent)[];
+    /**
+     * The id of the BuilderContent to apply the snapshot to
+     */
+    id: string;
+    /**
+     * Each snapshot can be either a full BuilderContent or individual BuilderElements.
+     * Order matters, as the snapshots will be applied in the order they are listed.
+     * The builder app will handle the logic of applying the snapshots in the correct order
+     * and to the right content/elements.
+     */
+    snapshots: (BuilderElement | BuilderContent)[];
 }
 export interface ContentApplySnapshotEvent {
-	type: "assistant.content.applysnapshot";
-	data: ContentApplySnapshot;
+    type: "assistant.content.applysnapshot";
+    data: ContentApplySnapshot;
 }
 export interface ContentUpdateEvent {
-	type: "assistant.content.update";
-	data: ContentUpdatePatch[];
+    type: "assistant.content.update";
+    data: ContentUpdatePatch[];
 }
-export type ContentUpdatePatch =
-	| ContentTsUpdateComponentPatch
-	| ContentThinkingPatch
-	| ContentCodegenPatch;
+export type ContentUpdatePatch = ContentTsUpdateComponentPatch | ContentThinkingPatch | ContentCodegenPatch;
 interface ContentPatchBase {
-	id: string;
-	nodeId?: string;
-	builderId?: string;
-	description?: string;
-	value: string;
-	displayValue?: string;
-	ts: number;
-	/**
-	 * A change value is considered incomplete until we also parsed it's closing xml tag.
-	 */
-	incomplete?: boolean;
-	/**
-	 * If there was an error applying the patch, this will contain the error message.
-	 */
-	error?: string;
-	/**
-	 * If `true`, Editor AI attempted to process this patch. It could be that the patch
-	 * had invalid syntax or that the LLM made its changes incorrectly. This can be used
-	 * to differentiate between a patch that is actively being streamed in, as indicated by
-	 * the "incomplete" property, and a patch that is has finished streaming and is being
-	 * processed.
-	 */
-	attemptedProcess?: boolean;
+    id: string;
+    nodeId?: string;
+    builderId?: string;
+    description?: string;
+    value: string;
+    displayValue?: string;
+    ts: number;
+    /**
+     * A change value is considered incomplete until we also parsed it's closing xml tag.
+     */
+    incomplete?: boolean;
+    /**
+     * If there was an error applying the patch, this will contain the error message.
+     */
+    error?: string;
+    /**
+     * If `true`, Editor AI attempted to process this patch. It could be that the patch
+     * had invalid syntax or that the LLM made its changes incorrectly. This can be used
+     * to differentiate between a patch that is actively being streamed in, as indicated by
+     * the "incomplete" property, and a patch that is has finished streaming and is being
+     * processed.
+     */
+    attemptedProcess?: boolean;
 }
 export interface ContentTsUpdateComponentPatch extends ContentPatchBase {
-	type: "update_component";
+    type: "update_component";
 }
 export interface ContentThinkingPatch extends ContentPatchBase {
-	type: "thinking";
+    type: "thinking";
 }
 export interface ContentCodegenPatch extends ContentPatchBase {
-	type: "codegen-text";
+    type: "codegen-text";
 }
 export interface AssistantStatsEvent {
-	type: "assistant.stats";
-	data: AssistantStats;
+    type: "assistant.stats";
+    data: AssistantStats;
 }
 export interface AssistantStats {
-	/**
-	 * The unique id of the thread (not the openai threadId)
-	 */
-	threadId: string;
-	/**
-	 * The unique id of the completion, which is a combination of the user's prompt and assistant's response.
-	 */
-	completionId: string;
-	/**
-	 * The model id used to generate this completion.
-	 */
-	modelId: string;
-	/**
-	 * The assistant's response message.
-	 */
-	assistantMessage: string;
-	/**
-	 * The assistant's summary of what it did. This appears after assistantMessage
-	 * as well as any changes it made.
-	 */
-	assistantSummary: string;
-	/**
-	 * The user's prompt message.
-	 */
-	userMessage: string;
-	/**
-	 * The index within the thread the assistant message is.
-	 * For a first assistant message, the index will be 1 (the user message is index 0).
-	 * For a second assistant message, the index will be 3 (the user message is index 2), and so on.
-	 */
-	assistantMessageIndex: number;
-	/**
-	 * The timestamp (Date.now()) of when the user first submitted their prompt.
-	 */
-	userPromptMs: number;
-	/**
-	 * The timestamp of the first assistant chunk in the response.
-	 */
-	firstChunkMs: number;
-	/**
-	 * The timestamp of the last assistant chunk in the response.
-	 */
-	lastChunkMs: number;
-	/**
-	 * The total number of chunks in the assistant's streamed response.
-	 */
-	chunkCount: number;
-	/**
-	 * The total number of characters in the generated prompt sent to the LLM.
-	 */
-	promptLength: number;
-	/**
-	 * The total number of characters in the assistant's response.
-	 */
-	completionLength: number;
-	/**
-	 * If the user provided custom instructions for the prompt.
-	 */
-	hasCustomInstructions: boolean;
-	/**
-	 * The deployed version.
-	 */
-	version: string;
-	/**
-	 * Error message if there was one.
-	 */
-	errorMessage?: string;
-	/**
-	 * Input tokens
-	 */
-	inputTokens?: number;
-	/**
-	 * 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;
+    /**
+     * The unique id of the thread (not the openai threadId)
+     */
+    threadId: string;
+    /**
+     * The unique id of the completion, which is a combination of the user's prompt and assistant's response.
+     */
+    completionId: string;
+    /**
+     * The model id used to generate this completion.
+     */
+    modelId: string;
+    /**
+     * The assistant's response message.
+     */
+    assistantMessage: string;
+    /**
+     * The assistant's summary of what it did. This appears after assistantMessage
+     * as well as any changes it made.
+     */
+    assistantSummary: string;
+    /**
+     * The user's prompt message.
+     */
+    userMessage: string;
+    /**
+     * The index within the thread the assistant message is.
+     * For a first assistant message, the index will be 1 (the user message is index 0).
+     * For a second assistant message, the index will be 3 (the user message is index 2), and so on.
+     */
+    assistantMessageIndex: number;
+    /**
+     * The timestamp (Date.now()) of when the user first submitted their prompt.
+     */
+    userPromptMs: number;
+    /**
+     * The timestamp of the first assistant chunk in the response.
+     */
+    firstChunkMs: number;
+    /**
+     * The timestamp of the last assistant chunk in the response.
+     */
+    lastChunkMs: number;
+    /**
+     * The total number of chunks in the assistant's streamed response.
+     */
+    chunkCount: number;
+    /**
+     * The total number of characters in the generated prompt sent to the LLM.
+     */
+    promptLength: number;
+    /**
+     * The total number of characters in the assistant's response.
+     */
+    completionLength: number;
+    /**
+     * If the user provided custom instructions for the prompt.
+     */
+    hasCustomInstructions: boolean;
+    /**
+     * The deployed version.
+     */
+    version: string;
+    /**
+     * Error message if there was one.
+     */
+    errorMessage?: string;
+    /**
+     * Input tokens
+     */
+    inputTokens?: number;
+    /**
+     * 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 ModelUndoEvent {
-	type: "assistant.model.undo";
+    type: "assistant.model.undo";
 }
 export interface ModelRedoEvent {
-	type: "assistant.model.redo";
+    type: "assistant.model.redo";
 }
 export interface BuilderModel {
-	name?: string;
-	friendlyName?: string;
-	description?: string;
-	type?: string;
-	fields?: BuilderModelField[];
+    name?: string;
+    friendlyName?: string;
+    description?: string;
+    type?: string;
+    fields?: BuilderModelField[];
 }
 export interface BuilderModelField {
-	name?: string;
-	type?: string;
-	description?: string;
+    name?: string;
+    type?: string;
+    description?: string;
 }
 export interface ThreadMessageFeedbackEvent {
-	type: "assistant.thread.message.feedback";
-	data: CompletionResponseFeedback;
+    type: "assistant.thread.message.feedback";
+    data: CompletionResponseFeedback;
 }
 export interface CompletionResponseFeedback {
-	userId: string;
-	builderUserId?: string;
-	builderEmail?: string;
-	responseId?: string;
-	frontendUrl: string | undefined;
-	frontendCommitId: string | undefined;
-	backendDomain?: string;
-	backendCommitId: string | undefined;
-	feedbackText: string;
-	sentiment?: "positive" | "negative" | "neutral";
-	frustration_level?: "none" | "low" | "medium" | "high";
-	repeated_attempts?: boolean;
-	confusion_level?: "none" | "low" | "medium" | "high";
-	urgency?: "none" | "low" | "medium" | "high";
-	satisfaction?: "none" | "low" | "medium" | "high";
+    userId: string;
+    builderUserId?: string;
+    builderEmail?: string;
+    responseId?: string;
+    frontendUrl: string | undefined;
+    frontendCommitId: string | undefined;
+    backendDomain?: string;
+    backendCommitId: string | undefined;
+    feedbackText: string;
+    sentiment?: "positive" | "negative" | "neutral";
+    frustration_level?: "none" | "low" | "medium" | "high";
+    repeated_attempts?: boolean;
+    confusion_level?: "none" | "low" | "medium" | "high";
+    urgency?: "none" | "low" | "medium" | "high";
+    satisfaction?: "none" | "low" | "medium" | "high";
 }
 export interface ThreadCreatedEvent {
-	type: "assistant.thread.created";
-	data: ThreadCreated;
+    type: "assistant.thread.created";
+    data: ThreadCreated;
 }
 export interface ThreadCreated {
-	platformId: string;
-	threadId: string;
-	vectorStoreId: string;
+    platformId: string;
+    threadId: string;
+    vectorStoreId: string;
 }
 export interface ThreadMessageCreatedEvent {
-	type: "assistant.thread.message.created";
-	data: ThreadMessageCreated;
+    type: "assistant.thread.message.created";
+    data: ThreadMessageCreated;
 }
 export interface ThreadMessageCreated {
-	id: string;
-	responseId: string;
-	threadId: string;
+    id: string;
+    responseId: string;
+    threadId: string;
 }
 export interface ThreadMessageDeltaEvent {
-	type: "assistant.thread.message.delta";
-	data: ThreadMessageDelta;
+    type: "assistant.thread.message.delta";
+    data: ThreadMessageDelta;
 }
 export interface AssistantHeartbeatEvent {
-	type: "assistant.heartbeat";
+    type: "assistant.heartbeat";
 }
 export interface ThreadMessageDelta {
-	id: string;
-	text: string;
+    id: string;
+    text: string;
 }
 export interface ThreadMessageCompletedEvent {
-	type: "assistant.thread.message.completed";
-	data: ThreadMessageCompleted;
+    type: "assistant.thread.message.completed";
+    data: ThreadMessageCompleted;
 }
 export interface ThreadMessageRetryEvent {
-	type: "assistant.thread.message.retry";
+    type: "assistant.thread.message.retry";
 }
 export interface ThreadMessageSummaryEvent {
-	type: "assistant.thread.message.summary.delta";
-	data: ThreadMessageDelta;
+    type: "assistant.thread.message.summary.delta";
+    data: ThreadMessageDelta;
 }
 export interface ThreadMessageSummaryCodegenDeltaEvent {
-	type: "assistant.thread.message.summary.codegen.delta";
-	data: {
-		id: string;
-		text: string;
-	};
+    type: "assistant.thread.message.summary.codegen.delta";
+    data: {
+        id: string;
+        text: string;
+    };
 }
 export interface ThreadMessageThinkingDeltaEvent {
-	type: "assistant.thread.message.thinking.delta";
-	data: {
-		id: string;
-		text: string;
-	};
+    type: "assistant.thread.message.thinking.delta";
+    data: {
+        id: string;
+        text: string;
+    };
 }
 export interface ThreadMessageCompleted extends AssistantMessage {
-	platformId: string;
-	threadId: string;
-	commitId?: string;
+    platformId: string;
+    threadId: string;
+    commitId?: string;
 }
 export interface ThreadRunStepDeltaEvent {
-	type: "assistant.thread.run.step.delta";
-	data: ThreadMessageStepDelta;
+    type: "assistant.thread.run.step.delta";
+    data: ThreadMessageStepDelta;
 }
 export interface ThreadMessageStepDelta {
-	delta: any;
+    delta: any;
 }
 export interface ThreadRunStepCreatedEvent {
-	type: "assistant.thread.run.step.created";
+    type: "assistant.thread.run.step.created";
 }
-export type DeepPartial<T> = T extends object
-	? {
-			[P in keyof T]?: DeepPartial<T[P]>;
-		}
-	: T;
+export type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
 export interface AssistantContentInitialEvent {
-	type: "assistant.content.initial";
-	data: {
-		code: string;
-	};
+    type: "assistant.content.initial";
+    data: {
+        code: string;
+    };
 }
 export interface AssistantFusionSuggestionEvent {
-	type: "assistant.fusion.suggestion";
-	data: {
-		url: string;
-		message: string;
-	};
+    type: "assistant.fusion.suggestion";
+    data: {
+        url: string;
+        message: string;
+    };
 }
 export {};