@builder.io/ai-utils 0.1.5 → 0.3.0

package/src/messages.ts

@@ -0,0 +1,240 @@
+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";
+  // Optional summary from the LLM that explains why it did
+  summary?: string;
+}
+
+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,354 +0,0 @@
-import type { Attachment, 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;
-    type?: "always" | "agent-mode" | string;
-    glob?: string;
-    description?: 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 interface ViewPathToolInput {
-    filePath: string;
-    viewRange?: [number, number];
-}
-export interface GlobSearchToolInput {
-    pattern: string;
-}
-export interface GrepSearchToolInput {
-    query: string;
-    includeGlob?: string;
-    excludeGlob?: string;
-}
-export interface GetRuleToolInput {
-    name: string;
-    type?: "always" | "agent-mode" | string;
-    glob?: string;
-    description?: string;
-}
-export interface CodeGenToolMap {
-    view_path: ViewPathToolInput;
-    glob_search: GlobSearchToolInput;
-    grep_search: GrepSearchToolInput;
-    get_rule: GetRuleToolInput;
-}
-export type CodeGenTools = keyof CodeGenToolMap;
-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" | "quality-v3";
-    url?: string;
-    diffActions?: boolean;
-    planningPrompt?: boolean;
-    customInstructions?: CustomInstruction[];
-    userPrompt?: string;
-    displayUserPrompt?: string;
-    files?: ProjectFile[];
-    rerankFiles?: number;
-    toolResults?: ContentMessageItemToolResult[];
-    attachments?: Attachment[];
-    beforeCommit?: string;
-    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 PromptSuggestion {
-    type: "missing-imports" | "lazy-code" | "syntax-error" | "llm-suggested" | "diff-apply";
-    filePath?: string;
-    line?: number;
-    importance: "high" | "medium" | "low";
-    column?: number;
-    summary: string;
-    prompt: string;
-}
-export interface ActionItem {
-    type: "file" | "text" | "diff" | "thinking" | "tool" | "suggestion" | "tool_result";
-    id?: string;
-    content: string;
-    filePath?: string;
-    artifactTitle?: string;
-    actionTitle?: string;
-    synthetic?: boolean;
-    incomplete?: boolean;
-    suggestions?: PromptSuggestion[];
-    errors?: string[];
-}
-export interface RepoInfo {
-    remoteUrl: string;
-    defaultBranch: string;
-    currentBranch: string;
-    commit: string;
-}
-export interface CodebaseSearchOptions {
-    repoInfo?: RepoInfo;
-    query: string;
-    selectedFiles?: string[];
-    sessionId: string;
-    files?: string[];
-    packageJson?: string;
-    limit?: number;
-    includeContent?: boolean;
-}
-export interface CodebaseSearchResponse {
-    id: string;
-    relevantPaths: string[];
-    grepQueries: string[];
-    streamMeta: any;
-    ranked: RankedResult[];
-}
-export interface RankedResult {
-    index: number;
-    filePath: string;
-    startIndex: number;
-    endIndex: number;
-    score: number;
-    id: string;
-    content?: string;
-}
-export interface GenerateCompletionStepThinking {
-    type: "thinking";
-}
-export interface FileInfo {
-    filePath: string;
-    size: number;
-}
-export interface GenerateCompletionStepUserInput {
-    type: "user-input";
-    prompt: string;
-    files: FileInfo[];
-}
-export interface GenerateCompletionStepToolResult {
-    type: "agent-input";
-    toolResults: ContentMessageItemToolResult[];
-}
-export interface GenerateCompletionStepPlanning {
-    type: "planning";
-    content: string;
-}
-export interface GenerateCompletionStepUser {
-    type: "user";
-    displayPrompt: string | undefined;
-    id: string;
-    role: "user" | "agent";
-}
-export interface GenerateCompletionStepFile {
-    type: "file";
-    filePath: string;
-    content: string;
-    title: string;
-    id: string;
-}
-export interface GenerateCompletionStepDiff {
-    type: "diff";
-    filePath: string;
-    content: string;
-    title: string;
-    id: string;
-}
-export interface GenerateCompletionStepTool {
-    type: "tool";
-    name: string;
-    id: string;
-    content: string;
-}
-export interface GenerateCompletionStepText {
-    type: "text";
-    content: string;
-}
-export interface GenerateCompletionStepDone {
-    type: "done";
-    id: string;
-    applyResults: ApplyActionsResult[];
-    actions: ActionItem[];
-    usage: CodegenUsage | undefined;
-    url?: string;
-    stopReason: CompletionStopReason;
-}
-export interface GenerateCompletionStepStart {
-    type: "start";
-    name: string;
-    id: string | undefined;
-    title: string;
-    content: string;
-}
-export interface GenerateCompletionStepDelta {
-    type: "delta";
-    name: string;
-    delta: string;
-}
-export interface GenerateCompletionStepError {
-    type: "error";
-    id?: string;
-    stopReason?: "error" | "limit";
-    metadata?: any;
-    message: string;
-    usage?: CodegenUsage;
-}
-export interface GenerateCompletionStepContinue {
-    type: "continue";
-    id: string;
-    url: string;
-}
-export interface GenerateCompletionStepWaitForInput {
-    type: "wait-for-input";
-}
-export interface GenerateCompletionStepAbort {
-    type: "user-abort";
-}
-export interface GenerateCompletionStepRestore {
-    type: "restore";
-    location: "before" | "after";
-    files: string[];
-    targetCompletionId: string;
-    lastCompletionId: string;
-    commitHash: string | undefined;
-}
-export type GenerateCompletionStep = {
-    timestamp?: number;
-} & (GenerateCompletionStepPlanning | GenerateCompletionStepStart | GenerateCompletionStepDelta | GenerateCompletionStepUser | GenerateCompletionStepFile | GenerateCompletionStepDiff | GenerateCompletionStepTool | GenerateCompletionStepError | GenerateCompletionStepContinue | GenerateCompletionStepWaitForInput | GenerateCompletionStepAbort | GenerateCompletionStepDone | GenerateCompletionStepUserInput | GenerateCompletionStepText | GenerateCompletionStepRestore | GenerateCompletionStepToolResult);
-export interface ApplyActionsResult {
-    filePath: string;
-    addedLines: number;
-    removedLines: number;
-    action: "create" | "update" | "delete";
-    content?: string;
-    oldContent?: string;
-}
-export interface GenerateUserMessage {
-    userPrompt: string;
-    displayPrompt?: string;
-    files?: string[];
-    includeBaseFiles?: boolean;
-    skipSearch?: boolean;
-    attachments?: Attachment[];
-}
-export interface UserInput {
-    userMessage: GenerateUserMessage | undefined;
-    userPrompt: string;
-    attachments: Attachment[];
-    files: ProjectFile[];
-    searchResponse: CodebaseSearchResponse | null;
-    rerankFiles?: number;
-    mostRelevantFile: string | null;
-    toolResults: ContentMessageItemToolResult[];
-    role: "user" | "agent";
-}
-export interface CodegenTurn {
-    state: "running" | "done" | "error" | "aborted" | "reverted";
-    unixTime: number;
-    completionId: string;
-    title: string;
-    nextUrl: string | undefined;
-    role: "user" | "agent";
-    actions: ActionItem[];
-    sentiment: "positive" | "negative" | "undo" | undefined;
-    applyResults: ApplyActionsResult[];
-    userMessage: GenerateUserMessage | undefined;
-    beforeCommit: string | undefined;
-    afterCommit: string | undefined;
-}
-export interface CodegenFeedback {
-    id: string;
-    feedbackText?: string;
-    feedbackSentiment?: string;
-    framework?: string;
-    acceptedLines?: number;
-    afterCommit?: string;
-}
-export interface GenerateCodeEventDone {
-    type: "done";
-    unixTime: number;
-    stopReason: CompletionStopReason;
-    id: string;
-    actionTitle: string;
-    content?: string;
-    needsPagination: boolean;
-    actions?: ActionItem[];
-    promptSuggestions: PromptSuggestion[];
-    usage?: CodegenUsage;
-    messageIndex: number;
-    willAutoContinue: boolean;
-    sessionUsage: number;
-    nextUrl: string;
-}
-export interface GenerateCodeEventError {
-    type: "error";
-    stopReason: "error" | "limit";
-    id: string;
-    message: string;
-    usage?: CodegenUsage;
-}
-export interface GenerateCodeEventPagination {
-    type: "pagination";
-    pop: number;
-    page: number;
-    id: string;
-}
-export interface GenerateCodeEventContinue {
-    type: "continue";
-    id: string;
-    nextUrl: string;
-}
-export interface GenerateCodeEventDelta {
-    type: "delta";
-    content: string;
-}
-export interface GenerateCodeEventUser {
-    type: "user";
-    id: string;
-    displayPrompt: string | undefined;
-    role: "user" | "agent";
-}
-export type GenerateCodeEvent = ActionItem | GenerateCodeEventDone | GenerateCodeEventContinue | GenerateCodeEventPagination | GenerateCodeEventDelta | GenerateCodeEventError | GenerateCodeEventUser;

package/src/codegen.js

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

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;
-}