@builder.io/ai-utils 0.0.14 → 0.0.16

package/dist/completion.d.ts

@@ -1,5 +1,5 @@
 import type { BuilderContent, BuilderElement, Component } from "@builder.io/sdk";
-import type { MessageParam } from "./messages";
+import type { MessageParam, SnippetParams } from "./messages";
 import type { BuilderModel } from "./events";
 export type BuilderContentData = BuilderContent["data"];
 export type { BuilderContent, BuilderElement, Component };
@@ -70,3 +70,8 @@ export interface CompletionOptions {
      */
     debug?: boolean;
 }
+export type OnPromptSubmit = (opts: {
+    prompt?: string;
+    snippetId?: string;
+    snippetParams?: SnippetParams;
+}) => void;

package/dist/events.d.ts

@@ -1,6 +1,7 @@
 import type { BuilderContent, BuilderElement, Component } from "@builder.io/sdk";
 import type { Thread } from "./thread";
 import type { AssistantMessage } from "./messages";
+import { AssistantSettings } from "./settings";
 export type BuilderAssistantEventHandler = (ev: BuilderAssistantEvent) => void;
 export type BuilderAssistantEvent = AppCloseEvent | AppMessagesClickEvent | AppMessagesGenerationEvent | AppPromptAbortEvent | AppPromptFocusEvent | AppPromptTextEvent | AppReadyEvent | AppSettingsResetEvent | AppSettingsSetEvent | AppThreadNewEvent | BuiderEditorStateEvent | ContentCreateEvent | ContentUpdateEvent | ContentApplySnapshotEvent | ContentCompleteEvent | ModelCreateEvent | ModelUpdateEvent | ResultEvent | ThreadCreatedEvent | ThreadMessageDeltaEvent | ThreadMessageCompletedEvent | ThreadMessageFeedbackEvent | ThreadRunRequiresActionEvent | ThreadRunStepCreatedEvent | ThreadRunStepDeltaEvent;
 export interface AppCloseEvent {
@@ -39,9 +40,9 @@ export interface AppReadyEvent {
 export interface AppSettingsResetEvent {
     type: "assistant.app.settings.reset";
 }
-export interface AppSettingsSetEvent<T = any> {
+export interface AppSettingsSetEvent {
     type: "assistant.app.settings.set";
-    data: DeepPartial<T>;
+    data: Partial<AssistantSettings>;
 }
 export interface AppThreadNewEvent {
     type: "assistant.app.thread.new";

package/dist/settings.d.ts

@@ -1,25 +1,51 @@
 import type { SnippetParams } from "./messages";
 export interface AssistantSettings {
     assistantType?: string;
-    requestState?: boolean;
+    cssOverrides?: string;
+    headingText: string;
     hideFrameworkPicker?: boolean;
-    messagePlaceholder: string;
     hideHeader?: boolean;
-    headingText: string;
-    cssOverrides?: string;
+    messagePlaceholder: string;
+    requestState?: boolean;
+    showAiCanMakeMistakes?: boolean;
     showCloseButton?: boolean;
+    showHeaderButton?: boolean;
+    showPrompt?: boolean;
     showSparklesInInputBar?: boolean;
-    suggestedItems: {
-        text: string;
-        prompt: string;
-        icon: any;
-        iconColor?: string;
-        snippetId?: string;
-        snippetParams?: SnippetParams;
-    }[];
-}
-export declare function getAssistantUrl(opts?: {
+    suggestedItems: Snippet[];
     theme?: "dark" | "light";
-    assistantType?: string;
+    transparentBackground?: boolean;
+}
+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;
+    /**
+     * The ID of the snippet that will be sent to the assistant when the user clicks the chat snippet button.
+     */
+    snippetId?: string;
+    /**
+     * The parameters that will be sent to the assistant when the user clicks the chat snippet button.
+     */
+    snippetParams?: SnippetParams;
+}
+interface IframeSettings extends Partial<AssistantSettings> {
     local?: boolean;
-}): string;
+}
+export declare function getAssistantUrl(opts?: IframeSettings): string;
+export declare function parseAssistantUrlSettings(url: string): Partial<AssistantSettings>;
+export {};

package/dist/settings.js

@@ -1,12 +1,39 @@
+const urlParamSettings = [
+    "assistantType",
+    "hideFrameworkPicker",
+    "hideHeader",
+    "showAiCanMakeMistakes",
+    "showCloseButton",
+    "showHeaderButton",
+    "showPrompt",
+    "showSparklesInInputBar",
+    "requestState",
+    "theme",
+    "transparentBackground",
+];
 export function getAssistantUrl(opts = {}) {
     const url = new URL(opts.local
         ? "http://localhost:7242"
         : "https://ai-assistant-tk43uighdq-uc.a.run.app");
-    if (opts.assistantType) {
-        url.searchParams.set("assistantType", opts.assistantType);
-    }
-    if (opts.theme) {
-        url.searchParams.set("theme", opts.theme);
-    }
+    urlParamSettings.forEach((key) => {
+        const value = opts[key];
+        if (typeof value === "string" || typeof value === "boolean") {
+            url.searchParams.set(key, String(value));
+        }
+    });
     return url.href;
 }
+export function parseAssistantUrlSettings(url) {
+    const parsed = new URL(url);
+    const settings = {};
+    urlParamSettings.forEach((key) => {
+        const value = parsed.searchParams.get(key);
+        if (value === "true" || value === "false") {
+            settings[key] = value === "true";
+        }
+        else if (value) {
+            settings[key] = value;
+        }
+    });
+    return settings;
+}

package/package.json

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