@builder.io/ai-utils 0.17.2 → 0.18.0

package/src/messages.d.ts

@@ -3,266 +3,317 @@ 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 type MessageParam =
+	| SystemMessageParam
+	| UserMessageParam
+	| AssistantMessageParam;
 export interface ContentMessageItemText {
-    type: "text";
-    text: string;
-    cache?: boolean;
-    citations?: TextCitationParam[] | null;
-    ephemeral?: boolean;
-    thoughtSignature?: string;
-    tag?: string;
+	type: "text";
+	text: string;
+	cache?: boolean;
+	citations?: TextCitationParam[] | null;
+	ephemeral?: boolean;
+	thoughtSignature?: string;
+	tag?: string;
 }
 export interface ContentMessageItemImage {
-    type: "image";
-    source: ImageBase64Source | ImageUrlSource;
-    cache?: boolean;
-    ephemeral?: boolean;
+	type: "image";
+	source: ImageBase64Source | ImageUrlSource;
+	cache?: boolean;
+	ephemeral?: boolean;
 }
 export interface ContentMessageItemDocument {
-    type: "document";
-    source: DocumentBase64Source | DocumentUrlSource | DocumentTextSource;
-    cache?: boolean;
-    ephemeral?: boolean;
-    title?: string;
+	type: "document";
+	source: DocumentBase64Source | DocumentUrlSource | DocumentTextSource;
+	cache?: boolean;
+	ephemeral?: boolean;
+	title?: string;
 }
 export interface ContentMessageItemVideo {
-    type: "video";
-    source: VideoUrlSource;
-    cache?: boolean;
-    ephemeral?: boolean;
+	type: "video";
+	source: VideoUrlSource;
+	cache?: boolean;
+	ephemeral?: boolean;
 }
 export interface DocumentBase64Source {
-    type: "base64";
-    media_type: "application/pdf";
-    data: string;
-    original_url?: string;
+	type: "base64";
+	media_type: "application/pdf";
+	data: string;
+	original_url?: string;
 }
 export interface DocumentUrlSource {
-    type: "url";
-    url: string;
+	type: "url";
+	url: string;
 }
 export interface DocumentTextSource {
-    type: "text";
-    media_type: "text/plain";
-    data: string;
+	type: "text";
+	media_type: "text/plain";
+	data: string;
 }
 export interface ContentMessageItemToolResult {
-    type: "tool_result";
-    tool_use_id: string;
-    tool_name?: string;
-    tool_input?: string;
-    title?: string;
-    content: string | (ContentMessageItemText | ContentMessageItemImage)[];
-    is_error?: boolean;
-    cache?: boolean;
-    ephemeral?: boolean;
-    structured_result?: Record<string, any>;
+	type: "tool_result";
+	tool_use_id: string;
+	tool_name?: string;
+	tool_input?: string;
+	title?: string;
+	content: string | (ContentMessageItemText | ContentMessageItemImage)[];
+	is_error?: boolean;
+	cache?: boolean;
+	ephemeral?: boolean;
+	structured_result?: Record<string, any>;
 }
 export interface ImageBase64Source {
-    type: "base64";
-    media_type: "image/webp" | "image/png" | "image/jpeg" | "image/gif";
-    data: string;
-    original_url?: string;
+	type: "base64";
+	media_type: "image/webp" | "image/png" | "image/jpeg" | "image/gif";
+	data: string;
+	original_url?: string;
 }
 export interface ImageUrlSource {
-    type: "url";
-    url: string;
+	type: "url";
+	url: string;
 }
 export interface VideoUrlSource {
-    type: "url";
-    url: string;
-    media_type?: "video/mp4" | "video/mov" | "video/mpeg" | "video/mpg" | "video/avi" | "video/wmv" | "video/webm" | "video/flv";
+	type: "url";
+	url: string;
+	media_type?:
+		| "video/mp4"
+		| "video/mov"
+		| "video/mpeg"
+		| "video/mpg"
+		| "video/avi"
+		| "video/wmv"
+		| "video/webm"
+		| "video/flv";
 }
 export interface ContentMessageItemThinking {
-    type: "thinking";
-    thinking: string;
-    signature: string;
-    source?: "openai" | "gemini";
-    id?: string;
+	type: "thinking";
+	thinking: string;
+	signature: string;
+	source?: "openai" | "gemini";
+	id?: string;
 }
 export interface ContentMessageItemRedactedThinking {
-    type: "redacted_thinking";
-    data: string;
-    source?: "openai" | "gemini";
-    id?: string;
+	type: "redacted_thinking";
+	data: string;
+	source?: "openai" | "gemini";
+	id?: string;
 }
 export interface ContentMessageItemToolUse {
-    type: "tool_use";
-    id: string;
-    provider_id?: string;
-    input: unknown;
-    completion?: string;
-    thoughtSignature?: string;
-    name: string;
+	type: "tool_use";
+	id: string;
+	provider_id?: string;
+	input: unknown;
+	completion?: string;
+	thoughtSignature?: string;
+	name: string;
 }
 export interface CitationCharLocationParam {
-    cited_text: string;
-    document_index: number;
-    document_title: string | null;
-    end_char_index: number;
-    start_char_index: number;
-    type: "char_location";
+	cited_text: string;
+	document_index: number;
+	document_title: string | null;
+	end_char_index: number;
+	start_char_index: number;
+	type: "char_location";
 }
 export interface CitationContentBlockLocationParam {
-    cited_text: string;
-    document_index: number;
-    document_title: string | null;
-    end_block_index: number;
-    start_block_index: number;
-    type: "content_block_location";
+	cited_text: string;
+	document_index: number;
+	document_title: string | null;
+	end_block_index: number;
+	start_block_index: number;
+	type: "content_block_location";
 }
 export interface CitationPageLocationParam {
-    cited_text: string;
-    document_index: number;
-    document_title: string | null;
-    end_page_number: number;
-    start_page_number: number;
-    type: "page_location";
+	cited_text: string;
+	document_index: number;
+	document_title: string | null;
+	end_page_number: number;
+	start_page_number: number;
+	type: "page_location";
 }
 export interface CitationWebSearchResultLocationParam {
-    cited_text: string;
-    encrypted_index: string;
-    title: string | null;
-    type: "web_search_result_location";
-    url: string;
-}
-export type TextCitationParam = CitationCharLocationParam | CitationPageLocationParam | CitationContentBlockLocationParam | CitationWebSearchResultLocationParam;
+	cited_text: string;
+	encrypted_index: string;
+	title: string | null;
+	type: "web_search_result_location";
+	url: string;
+}
+export type TextCitationParam =
+	| CitationCharLocationParam
+	| CitationPageLocationParam
+	| CitationContentBlockLocationParam
+	| CitationWebSearchResultLocationParam;
 export interface ServerToolUseContent {
-    type: "web_search_result";
-    title: string;
-    url: string;
-    page_age: string | null;
-    encrypted_content: string;
+	type: "web_search_result";
+	title: string;
+	url: string;
+	page_age: string | null;
+	encrypted_content: string;
 }
 export interface ServerToolUseContentError {
-    error_code: "invalid_tool_input" | "unavailable" | "max_uses_exceeded" | "too_many_requests" | "query_too_long";
-    type: "web_search_tool_result_error";
-}
-export type ServerToolUseContentUnion = ServerToolUseContent[] | ServerToolUseContentError;
+	error_code:
+		| "invalid_tool_input"
+		| "unavailable"
+		| "max_uses_exceeded"
+		| "too_many_requests"
+		| "query_too_long";
+	type: "web_search_tool_result_error";
+}
+export type ServerToolUseContentUnion =
+	| ServerToolUseContent[]
+	| ServerToolUseContentError;
 export interface ContentMessageItemServerToolUse {
-    type: "server_tool_use";
-    id: string;
-    name: "web_search" | "code_execution" | "web_fetch" | "bash_code_execution" | "text_editor_code_execution" | "tool_search_tool_regex" | "tool_search_tool_bm25";
-    input: unknown;
-    completion?: string;
-    content?: any;
-    cache?: boolean;
+	type: "server_tool_use";
+	id: string;
+	name:
+		| "web_search"
+		| "code_execution"
+		| "web_fetch"
+		| "bash_code_execution"
+		| "text_editor_code_execution"
+		| "tool_search_tool_regex"
+		| "tool_search_tool_bm25";
+	input: unknown;
+	completion?: string;
+	content?: any;
+	cache?: boolean;
 }
 export interface MCPServerURLDefinition {
-    name: string;
-    type: "url";
-    url: string;
-    authorization_token?: string | null;
-    tool_configuration?: MCPServerToolConfiguration | null;
-    token_expires_at?: number | null;
-    create_date?: number | null;
-    serverId: string;
-    disabled: boolean;
+	name: string;
+	type: "url";
+	url: string;
+	authorization_token?: string | null;
+	tool_configuration?: MCPServerToolConfiguration | null;
+	token_expires_at?: number | null;
+	create_date?: number | null;
+	serverId: string;
+	disabled: boolean;
 }
 export interface MCPServerToolConfiguration {
-    allowed_tools?: Array<string> | null;
-    enabled?: boolean | null;
+	allowed_tools?: Array<string> | null;
+	enabled?: boolean | null;
 }
 export interface ContentMessageItemWebSearchToolResult {
-    content: ServerToolUseContent[] | ServerToolUseContentError;
-    tool_use_id: string;
-    type: "web_search_tool_result";
-    cache?: boolean;
+	content: ServerToolUseContent[] | ServerToolUseContentError;
+	tool_use_id: string;
+	type: "web_search_tool_result";
+	cache?: boolean;
 }
 export interface ContentMessageItemMCPToolUse {
-    type: "mcp_tool_use";
-    id: string;
-    name: string;
-    input: unknown;
-    server_name: string;
-    cache?: boolean;
+	type: "mcp_tool_use";
+	id: string;
+	name: string;
+	input: unknown;
+	server_name: string;
+	cache?: boolean;
 }
 export interface ContentMessageItemContainerUpload {
-    type: "container_upload";
-    file_id: string;
+	type: "container_upload";
+	file_id: string;
 }
 export interface ContentMessageItemMCPToolResult {
-    type: "mcp_tool_result";
-    tool_use_id: string;
-    content: string | ContentMessageItemText[];
-    is_error: boolean;
-    cache?: boolean;
+	type: "mcp_tool_result";
+	tool_use_id: string;
+	content: string | ContentMessageItemText[];
+	is_error: boolean;
+	cache?: boolean;
 }
 export interface ContentMessageItemCodeExecutionToolResult {
-    type: "code_execution_tool_result";
-    tool_use_id: string;
-    content: any;
-    cache?: boolean;
-}
-export type ContentMessageItem = ContentMessageItemText | ContentMessageItemImage | ContentMessageItemDocument | ContentMessageItemVideo | ContentMessageItemThinking | ContentMessageItemRedactedThinking | ContentMessageItemToolUse | ContentMessageItemToolResult | ContentMessageItemWebSearchToolResult | ContentMessageItemServerToolUse | ContentMessageItemMCPToolUse | ContentMessageItemMCPToolResult | ContentMessageItemContainerUpload | ContentMessageItemCodeExecutionToolResult;
+	type: "code_execution_tool_result";
+	tool_use_id: string;
+	content: any;
+	cache?: boolean;
+}
+export type ContentMessageItem =
+	| ContentMessageItemText
+	| ContentMessageItemImage
+	| ContentMessageItemDocument
+	| ContentMessageItemVideo
+	| ContentMessageItemThinking
+	| ContentMessageItemRedactedThinking
+	| ContentMessageItemToolUse
+	| ContentMessageItemToolResult
+	| ContentMessageItemWebSearchToolResult
+	| ContentMessageItemServerToolUse
+	| ContentMessageItemMCPToolUse
+	| ContentMessageItemMCPToolResult
+	| ContentMessageItemContainerUpload
+	| ContentMessageItemCodeExecutionToolResult;
 export type ContentMessage = ContentMessageItem[];
 export interface SystemMessageParam {
-    /**
-     * The contents of the system message.
-     */
-    content: string | ContentMessageItemText[];
-    responseId?: string;
-    /**
-     * The role of the messages author, in this case `system`.
-     */
-    role: "system";
-    id?: string;
+	/**
+	 * The contents of the system message.
+	 */
+	content: string | ContentMessageItemText[];
+	responseId?: string;
+	/**
+	 * The role of the messages author, in this case `system`.
+	 */
+	role: "system";
+	id?: string;
 }
 export interface UserMessageParam {
-    /**
-     * The contents of the user message.
-     */
-    content: string | (ContentMessageItemText | ContentMessageItemImage | ContentMessageItemDocument | ContentMessageItemVideo | ContentMessageItemToolResult)[];
-    responseId?: string;
-    /**
-     * The role of the messages author, in this case `user`.
-     */
-    role: "user";
-    id?: string;
+	/**
+	 * The contents of the user message.
+	 */
+	content:
+		| string
+		| (
+				| ContentMessageItemText
+				| ContentMessageItemImage
+				| ContentMessageItemDocument
+				| ContentMessageItemVideo
+				| ContentMessageItemToolResult
+		  )[];
+	responseId?: string;
+	/**
+	 * The role of the messages author, in this case `user`.
+	 */
+	role: "user";
+	id?: string;
 }
 export type AssistantMessageAction = "new-chat";
 export interface AssistantMessageParam {
-    /**
-     * The contents of the assistant message.
-     */
-    content: string | ContentMessageItem[];
-    /**
-     * The role of the messages author, in this case `assistant`.
-     */
-    role: "assistant";
-    responseId?: string;
-    id?: string;
-    skipDelta?: boolean;
-    /**
-     * A summary of the patches which the assistant has made.
-     * Useful for genai.
-     */
-    patches?: ContentUpdatePatch[];
-    state?: "error";
-    /**
-     * Any actions associated with the error such as a "new chat" button.
-     * typically used when there is an error.
-     */
-    actions?: AssistantMessageAction[];
+	/**
+	 * The contents of the assistant message.
+	 */
+	content: string | ContentMessageItem[];
+	/**
+	 * The role of the messages author, in this case `assistant`.
+	 */
+	role: "assistant";
+	responseId?: string;
+	id?: string;
+	skipDelta?: boolean;
+	/**
+	 * A summary of the patches which the assistant has made.
+	 * Useful for genai.
+	 */
+	patches?: ContentUpdatePatch[];
+	state?: "error";
+	/**
+	 * Any actions associated with the error such as a "new chat" button.
+	 * typically used when there is an error.
+	 */
+	actions?: AssistantMessageAction[];
 }
 export interface SystemMessage extends SystemMessageParam {
-    id: string;
+	id: string;
 }
 export interface UserMessage extends UserMessageParam {
-    id: string;
+	id: string;
 }
 export interface AssistantMessage extends AssistantMessageParam {
-    id: string;
-    status?: "accepted" | "rejected" | "aborted";
-    summary?: string;
+	id: string;
+	status?: "accepted" | "rejected" | "aborted";
+	summary?: string;
 }
 export interface AssistantActionMessage {
-    /**
-     * The role of the messages author, in this case `assistant`.
-     */
-    role: "assistant";
-    id: string;
+	/**
+	 * The role of the messages author, in this case `assistant`.
+	 */
+	role: "assistant";
+	id: string;
 }
 /**
  * Message DOES know the id of the message.
@@ -270,35 +321,53 @@ export interface AssistantActionMessage {
  * and is the output message.
  */
 export type Message = SystemMessage | UserMessage | AssistantMessage;
-export type GeneratingMessage = null | Partial<AssistantActionMessage | AssistantMessage>;
-export declare function getContentText(message: string | ContentMessage): string;
-export declare function getContentAttachments(message: string | ContentMessage): (ImageBase64Source | ImageUrlSource)[];
-export type Attachment = FileUpload | Template | URL | BuilderContentAttachment | FigmaContentAttachment;
+export type GeneratingMessage = null | Partial<
+	AssistantActionMessage | AssistantMessage
+>;
+export declare function getContentText(
+	message: string | ContentMessage,
+): string;
+export declare function getContentAttachments(
+	message: string | ContentMessage,
+): (ImageBase64Source | ImageUrlSource)[];
+export type Attachment =
+	| FileUpload
+	| Template
+	| URL
+	| BuilderContentAttachment
+	| FigmaContentAttachment;
 export interface URL {
-    type: "url";
-    value: string;
+	type: "url";
+	value: string;
 }
 export interface FileUpload {
-    type: "upload";
-    contentType: "image/webp" | "image/png" | "image/jpeg" | "image/gif" | "application/pdf" | "application/json" | "text/plain";
-    name: string;
-    dataUrl: string;
-    text?: string;
-    size: number;
-    id: string;
-    originalUrl?: string;
-    ephemeral?: boolean;
+	type: "upload";
+	contentType:
+		| "image/webp"
+		| "image/png"
+		| "image/jpeg"
+		| "image/gif"
+		| "application/pdf"
+		| "application/json"
+		| "text/plain";
+	name: string;
+	dataUrl: string;
+	text?: string;
+	size: number;
+	id: string;
+	originalUrl?: string;
+	ephemeral?: boolean;
 }
 export interface Template {
-    type: "template";
-    name: string;
-    id: number;
+	type: "template";
+	name: string;
+	id: number;
 }
 export interface BuilderContentAttachment {
-    type: "builder";
-    html: string;
+	type: "builder";
+	html: string;
 }
 export interface FigmaContentAttachment {
-    type: "figma";
-    html: string;
+	type: "figma";
+	html: string;
 }

package/src/messages.js

@@ -1,16 +1,16 @@
 export function getContentText(message) {
-    if (typeof message === "string") {
-        return message;
-    }
-    return message
-        .map((item) => (item.type === "text" ? item.text : ""))
-        .join("");
+	if (typeof message === "string") {
+		return message;
+	}
+	return message
+		.map((item) => (item.type === "text" ? item.text : ""))
+		.join("");
 }
 export function getContentAttachments(message) {
-    if (typeof message === "string") {
-        return [];
-    }
-    return message
-        .filter((item) => item.type === "image")
-        .map((item) => item.source);
+	if (typeof message === "string") {
+		return [];
+	}
+	return message
+		.filter((item) => item.type === "image")
+		.map((item) => item.source);
 }