@builder.io/ai-utils 0.0.76 → 0.1.1

package/src/messages.ts

@@ -0,0 +1,238 @@
+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: ImageBase64Source | ImageUrlSource;
+  cache?: boolean;
+}
+
+export interface ContentMessageItemDocument {
+  type: "document";
+  source: DocumentBase64Source | DocumentUrlSource;
+  cache?: boolean;
+}
+
+export interface DocumentBase64Source {
+  type: "base64";
+  media_type: "application/pdf";
+  data: string;
+}
+
+export interface DocumentUrlSource {
+  type: "url";
+  url: string;
+}
+
+export interface ContentMessageItemToolResult {
+  type: "tool_result";
+  tool_use_id: string;
+  tool_name?: string;
+  tool_input?: string;
+  title?: string;
+  content: string;
+  is_error: boolean;
+  cache?: boolean;
+}
+
+export interface ImageBase64Source {
+  type: "base64";
+  media_type: "image/webp" | "image/png" | "image/jpeg";
+  data: string;
+}
+
+export interface ImageUrlSource {
+  type: "url";
+  url: 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;
+  completion?: string;
+  name: string;
+}
+
+export type ContentMessageItem =
+  | ContentMessageItemText
+  | ContentMessageItemImage
+  | ContentMessageItemDocument
+  | ContentMessageItemThinking
+  | ContentMessageItemRedactedThinking
+  | ContentMessageItemToolUse
+  | ContentMessageItemToolResult;
+
+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
+        | ContentMessageItemDocument
+        | ContentMessageItemToolResult
+      )[];
+
+  // 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 | URL;
+
+export interface URL {
+  type: "url";
+  value: string;
+}
+
+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,59 @@
+export interface AssistantSettings {
+  assistantType?: string;
+  viewId?: string;
+  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",
+  "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/codegen.d.ts

@@ -1,92 +0,0 @@
-import type { ContentMessageItemToolResult, UserMessageParam } from "./messages";
-import type { BuilderContent } from "./completion";
-import type { Options as PrettierOptions } from "prettier";
-import type { UserContext } from "./mapping";
-import type { AssistantMessageParam } from "./messages";
-export type ImportType = "named" | "default";
-export interface ESMImport {
-    importName: string;
-    importPath: string;
-    importType: ImportType;
-}
-export interface ProjectFile {
-    filePath: string;
-    content?: string;
-    importance?: number;
-    dropReason?: string;
-    wasIncluded?: boolean;
-}
-export interface CustomInstruction {
-    id: string;
-    name: string;
-    content: string;
-}
-export type CodeGenFramework = "react" | "html" | "mitosis" | "react-native" | "angular" | "vue" | "svelte" | "qwik" | "solid" | "marko" | "swiftui" | "jetpack-compose" | "flutter";
-export type CodeGenStyleLibrary = "tailwind" | "tailwind-precise" | "emotion" | "styled-components" | "styled-jsx" | "react-native" | undefined;
-export type CompletionStopReason = "max_tokens" | "stop_sequence" | "tool_use" | "end_turn" | "content_filter" | null;
-export type CodeGenStopReason = "error" | "limit" | CompletionStopReason;
-export type CodeGenTools = "view_file_content";
-export type CodeGenMode = "exact" | "precise" | "precise_vision" | "creative" | "creative_vision" | "creative_only_vision";
-export interface CodeGenInputOptions {
-    position: string;
-    eventName?: string;
-    sessionId: string;
-    codeGenMode?: "fast" | "quality-v2" | "agent";
-    url?: string;
-    diffActions?: boolean;
-    planningPrompt?: boolean;
-    customInstructions?: CustomInstruction[];
-    userPrompt?: string;
-    files?: ProjectFile[];
-    rerankFiles?: number;
-    toolResults?: ContentMessageItemToolResult[];
-    builderContent?: BuilderContent;
-    framework?: CodeGenFramework;
-    styleLibrary?: CodeGenStyleLibrary;
-    typescript?: boolean;
-    userContext?: UserContext;
-    enabledTools?: CodeGenTools[];
-    maxTokens?: number;
-    maxPages?: number;
-    autoContinue?: number;
-    promptCaching?: boolean;
-    isAutoContinue?: boolean;
-    llmSuggestions?: boolean;
-    conclusionText?: boolean;
-    searchResponse?: any | null;
-    prettierConfig?: PrettierOptions;
-    /** @deprecated */
-    history?: (UserMessageParam | AssistantMessageParam)[];
-    /** @deprecated */
-    prevId?: string;
-    /** @deprecated */
-    nextPage?: boolean;
-    /** @deprecated */
-    vcpId?: string;
-}
-export type Feature = "component-mapping";
-export interface CodegenUsage {
-    total: number;
-    fast: number;
-    quality: number;
-    features: Feature[];
-    limits: {
-        aiGeneration: number;
-        aiGenerationContextWindow: number;
-    };
-}
-export interface ActionItem {
-    type: "file" | "text" | "delta" | "done" | "diff" | "thinking" | "user" | "tool" | "suggestion" | "continue";
-    id?: string;
-    content: string;
-    filePath?: string;
-    artifactTitle?: string;
-    actionTitle?: string;
-    synthetic?: boolean;
-    incomplete?: boolean;
-    nextUrl?: string;
-    actions?: ActionItem[];
-    stopReason?: CodeGenStopReason;
-    usage?: CodegenUsage;
-    errors?: string[];
-}

package/src/codegen.js

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

package/src/completion.d.ts

@@ -1,153 +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 { 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 {};