@builder.io/ai-utils 0.0.73 → 0.0.74

package/src/messages.ts

@@ -0,0 +1,190 @@
+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 | ContentMessageItemText[];
+
+  // an id to track messages across a response including multiple retries
+  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)[];
+
+  // an id to track messages across a response including multiple retries
+  responseId?: string;
+
+  /**
+   * The role of the messages author, in this case `user`.
+   */
+  role: "user";
+  id?: string;
+}
+
+export interface AssistantMessageParam {
+  /**
+   * The contents of the assistant message.
+   */
+  content: string | ContentMessageItem[];
+  /**
+   * The role of the messages author, in this case `assistant`.
+   */
+  role: "assistant";
+
+  // an id to track messages across a response including multiple retries
+  responseId?: string;
+
+  /**
+   * The function call name and arguments
+   */
+  action?: {
+    /**
+     * The specific function name
+     */
+    name: string;
+    /** This is arbitrary JSON */
+    arguments: any;
+  };
+  id?: string;
+  skipDelta?: boolean;
+  /**
+   * A summary of the patches which the assistant has made.
+   * Useful for genai.
+   */
+  patches?: ContentUpdatePatch[];
+  state?: "error";
+}
+
+export interface SystemMessage extends SystemMessageParam {
+  id: string;
+}
+
+export interface UserMessage extends UserMessageParam {
+  id: string;
+}
+
+export interface AssistantMessage extends AssistantMessageParam {
+  id: string;
+  status?: "accepted" | "rejected" | "aborted";
+}
+
+export interface AssistantActionMessage {
+  /**
+   * The role of the messages author, in this case `assistant`.
+   */
+  role: "assistant";
+
+  id: string;
+}
+
+/**
+ * Message DOES know the id of the message.
+ * This message is after an id has been assigned
+ * and is the output message.
+ */
+export type Message = SystemMessage | UserMessage | AssistantMessage;
+
+export type GeneratingMessage = null | Partial<
+  AssistantActionMessage | AssistantMessage
+>;
+
+export function getContentText(message: string | ContentMessage) {
+  if (typeof message === "string") {
+    return message;
+  }
+  return message
+    .map((item) => (item.type === "text" ? item.text : ""))
+    .join("");
+}
+
+export function getContentAttachments(message: string | ContentMessage) {
+  if (typeof message === "string") {
+    return [];
+  }
+  return message
+    .filter((item) => item.type === "image")
+    .map((item) => item.source);
+}
+
+export type Attachment = FileUpload | Template;
+
+export interface FileUpload {
+  type: "upload";
+  contentType: string;
+  name: string;
+  dataUrl: string;
+  size: number;
+  id: string;
+}
+
+export interface Template {
+  type: "template";
+  name: string;
+  id: number;
+}

package/src/settings.ts

@@ -0,0 +1,63 @@
+export interface AssistantSettings {
+  assistantType?: string;
+  viewId?: string;
+  cssOverrides?: string;
+  messagePlaceholder: string;
+  showPrompt?: boolean;
+  theme?: "dark" | "light";
+}
+
+interface IframeSettings extends Partial<AssistantSettings> {
+  local?: boolean;
+  /**
+   * The URL of the assistant.
+   */
+  baseUrl?: string;
+}
+
+type AssistantSettingsKeys = keyof AssistantSettings;
+
+const urlParamSettings: AssistantSettingsKeys[] = [
+  "assistantType",
+  "showPrompt",
+  "theme",
+  "viewId",
+];
+
+export function getAssistantUrl(opts: IframeSettings = {}) {
+  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") {
+      url.searchParams.set(key, String(value));
+    }
+  });
+
+  return url.href;
+}
+
+export function parseAssistantUrlSettings(url: string) {
+  const parsed = new URL(url);
+  const settings: Record<string, string | boolean> = {};
+
+  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 as Partial<AssistantSettings>;
+}
+
+export interface BuilderEditorAuth {
+  spaceId: string;
+  userId: string;
+  authToken: string;
+}

package/src/thread.ts

@@ -0,0 +1,28 @@
+import type { Message } from "./messages.js";
+
+export interface Thread {
+  /**
+   * The unique LOCAL identifier of the thread.
+   */
+  id: string;
+  /**
+   * The unique OPENAI identifier of the thread. This is only
+   * set after openai creates the 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/src/vcp.ts

@@ -0,0 +1,32 @@
+import type { ESMImport } from "./codegen";
+
+export interface BuilderComponentInfo {
+  name: string;
+  inputs?: BuilderComponentInput[];
+  path: string;
+  imports: { [key: string]: string | undefined };
+  esmImports?: ESMImport[];
+  options?: any;
+}
+
+export interface BuilderComponentInput {
+  name: string;
+  type: string;
+  value: any;
+}
+
+export interface BuilderComponentSlot {
+  figmaId: string;
+  builderName: string;
+}
+
+export interface JSXNode {
+  "@type": "jsx";
+  name: string;
+  props: Record<string, any>;
+  tagName?: string;
+  includeAirLayoutStyles?: boolean;
+  path?: string;
+  imports?: { [key: string]: string | undefined };
+  esmImports?: ESMImport[];
+}

package/src/complete-json.d.ts

@@ -1,4 +0,0 @@
-/**
- * Complete a partial JSON string with the necessary closing brackets and braces
- */
-export declare function completeJson(input: string): string;

package/src/complete-json.js

@@ -1,52 +0,0 @@
-/**
- * Complete a partial JSON string with the necessary closing brackets and braces
- */
-export function completeJson(input) {
-    const stack = [];
-    let isInString = false;
-    let lastQuote = "";
-    // Scan the string to determine the necessary closures
-    for (const char of input) {
-        switch (char) {
-            case '"':
-            case "'":
-                if (isInString && char === lastQuote) {
-                    // Check for escaping
-                    if (input.charAt(input.indexOf(char) - 1) !== "\\") {
-                        isInString = false;
-                    }
-                }
-                else if (!isInString) {
-                    isInString = true;
-                    lastQuote = char;
-                }
-                break;
-            case "{":
-            case "[":
-                if (!isInString) {
-                    stack.push(char === "{" ? "}" : "]");
-                }
-                break;
-            case "}":
-            case "]":
-                if (!isInString) {
-                    if (stack.length > 0 && stack[stack.length - 1] === char) {
-                        stack.pop();
-                    }
-                }
-                break;
-            default:
-                break;
-        }
-    }
-    // Close any unclosed string
-    if (isInString) {
-        input += lastQuote;
-    }
-    // Close all remaining open brackets and braces
-    while (stack.length > 0) {
-        const charToClose = stack.pop();
-        input += charToClose;
-    }
-    return input;
-}

package/src/completion.d.ts

@@ -1,154 +0,0 @@
-import type { BuilderContent, BuilderElement, Component } from "@builder.io/sdk";
-import type { Message, MessageParam, Attachment } from "./messages.js";
-import type { BuilderModel } from "./events.js";
-export type BuilderContentData = BuilderContent["data"];
-export type { BuilderContent, BuilderElement, Component };
-export interface CompletionOptions {
-    /**
-     * How this assistant is being used. For example, "content-editor"
-     * is used when the assistant is being used in the Builder.io content editor.
-     */
-    assistantType?: string;
-    /**
-     * LLM Model identifier to lookup which sdk and model to use.
-     * If not provided the default model will be used.
-     * Note: This is not the Builder.io data model.
-     */
-    modelId?: string;
-    /**
-     * The unique LOCAL identifier of the thread to submit the user message to.
-     * This is used to identify the thread with our own id (openai assistant id is different)
-     */
-    id: string;
-    /**
-     * The unique OPENAI assistant id of the thread to submit the user message to.
-     * If the assistantThreadId is not provided, a new thread will be created.
-     */
-    assistantThreadId?: string;
-    /**
-     * The message history of the conversation, user prompt then assistant response.
-     * The messages are ordered from oldest to newest. The last message in the array
-     * is the message that the user has just sent.
-     */
-    messages: (MessageParam | Message)[];
-    /**
-     * Which platform (framework) the the user has choosen to get help with.
-     */
-    platformId?: string;
-    /**
-     * The user id of the user sending the message.
-     * This is used to track the user's progress in the conversation.
-     * User id is stored in localStorage for this domain, its not the builder user id.
-     */
-    userId: string;
-    /**
-     * The state of the builder editor.
-     */
-    builderState?: BuilderEditorState;
-    /**
-     * Additional console logs
-     */
-    debug?: boolean;
-    /**
-     * Date.now() timestamp of when the assistant was started.
-     * This is used to calculate the time taken between all events.
-     */
-    startMs?: number;
-    /**
-     * If events should be streamed back throughout the process.
-     *
-     * Setting to `false` will skip any intermediate processing and emitting
-     * events while collecting LLM deltas, but will only emit the final result.
-     *
-     * Defaults to `true`.
-     */
-    stream?: boolean;
-    /**
-     * Provide a system prompt id to lookup a pre-defined system prompt
-     * text sent to the LLM. Must be a pre-defined system prompt id!
-     */
-    systemPromptIds?: {
-        "content-edit"?: string;
-    };
-    /**
-     * Option on how this call should handle the conversation thread.
-     *
-     * `persist`:
-     *  - When there is no CompletionOptions `id`, it'll create a new thread id
-     *  - When given an existing `id`, it'll look up the past thread messages and prefix the messages
-     *
-     * `ephemeral`:
-     *  - Creates a new conversation each time, ignoring any existing thread history
-     *  - Will not save the conversation for future use
-     *
-     * Defaults to `persist`
-     */
-    thread?: "persist" | "ephemeral";
-    attachments?: Attachment[];
-}
-export interface BuilderEditorState {
-    /**
-     * The active locale of the builder editor.
-     */
-    activeLocale?: string;
-    /**
-     * The locale of the provided builder content.
-     */
-    contentLocale?: string;
-    /**
-     * Top level Builder content. The data.blocks array contains the BuilderElement.
-     */
-    content?: BuilderContent;
-    /**
-     * Builder custom components.
-     */
-    components?: Component[];
-    /**
-     * Builder design tokens.
-     */
-    designTokens?: Record<string, string>;
-    /**
-     * Builder model. (not the LLM model)
-     */
-    model?: BuilderModel;
-    /**
-     * Other models in the Builder account
-     */
-    otherModels?: BuilderModel[];
-    /**
-     * The URL that the Builder content preview is pointing to.
-     */
-    previewUrl?: string;
-    /**
-     * Selected ids in the builder.
-     */
-    selectedIds?: string[];
-    /**
-     * Builder space id.
-     */
-    spaceId?: string;
-    /**
-     * Builder user id.
-     */
-    userId?: string;
-    /**
-     * Email of the user in the builder.
-     */
-    userEmail?: string;
-    /**
-     * User's jobs
-     */
-    userJobs?: string[];
-    /**
-     * Builder session id.
-     */
-    sessionId?: string;
-    /**
-     * Custom instructions that could be add into the prompt.
-     */
-    customInstructions?: Record<string, string>;
-    /**
-     * All targeting attributes of the content.
-     */
-    allTargetingAttributes?: Record<string, any>;
-}

package/src/completion.js

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