@builder.io/ai-utils 0.3.16 → 0.3.17

package/README.md

@@ -0,0 +1,3 @@
+# Builder.io AI types and utilities
+
+Shared types between AI systems, threads, servers, etc.

package/package.json

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

package/src/codegen.ts

@@ -0,0 +1,686 @@
+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";
+
+// Define the import type as a union of literal types.
+export type ImportType = "named" | "default";
+
+// Define an interface for the import descriptor.
+export interface ESMImport {
+  importName: string; // e.g. "Button"
+  importPath: string; // e.g. "path"
+  importType: ImportType; // Either 'named' or 'default'
+}
+
+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";
+  filePath?: 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"
+  | "error"
+  | "aborted"
+  | "pause_turn"
+  | "refusal"
+  | null;
+
+export interface ViewPathToolInput {
+  file_path: string;
+  view_range?: [number, number];
+}
+
+export interface GlobSearchToolInput {
+  pattern: string;
+}
+
+export interface GrepSearchToolInput {
+  query: string;
+  include_glob?: string;
+  exclude_glob?: string;
+}
+
+export interface GetRuleToolInput {
+  name: string;
+}
+
+export interface GetStyleInspirationToolInput {
+  url: string;
+}
+
+export interface GetBuildOutputToolInput {}
+export interface DevServerControlInput {
+  restart?: boolean;
+  get_logs?: boolean;
+}
+
+export interface BashToolInput {
+  command?: string;
+  restart?: boolean;
+}
+
+export interface WebSearchToolInput {
+  query: string;
+}
+
+export interface WriteFileInput {
+  title: string;
+  file_path: string;
+  content: string;
+}
+
+export interface SearchReplaceInput {
+  title: string;
+  file_path: string;
+  old_str: string;
+  new_str: string;
+}
+
+export interface CodeGenToolMap {
+  view_path: ViewPathToolInput;
+  glob_search: GlobSearchToolInput;
+  grep_search: GrepSearchToolInput;
+  get_rule: GetRuleToolInput;
+  get_style_inspiration: GetStyleInspirationToolInput;
+  get_build_output: GetBuildOutputToolInput;
+  dev_server_control: DevServerControlInput;
+  bash: BashToolInput;
+  web_search: WebSearchToolInput;
+  write_file: WriteFileInput;
+  search_replace_file: SearchReplaceInput;
+}
+
+export type CodeGenTools = keyof CodeGenToolMap;
+
+export type AllCodeGenTools =
+  | CodeGenTools
+  | "str_replace_editor"
+  | "web_search";
+
+export type CodeGenMode =
+  | "exact" // @deprecated
+  | "precise" // tries to match the design as close
+  | "precise_vision" // tries to match the design as close, also uses vision to match
+  | "creative" // adapts the design to some generic design language
+  | "creative_vision" // adapts the design to some generic design language, also uses vision to match
+  | "creative_only_vision"; // adapts the design to some generic design language, but only uses vision to match
+
+export interface CodeGenInputOptions {
+  position: string;
+  eventName?: string;
+  sessionId: string;
+
+  codeGenMode?: "fast" | "quality" | "quality-v3";
+  url?: string;
+  diffActions?: boolean;
+  planningPrompt?: boolean;
+  customInstructions?: CustomInstruction[];
+  userPrompt?: string;
+  ephemeralUserPrompt?: string;
+  displayUserPrompt?: string;
+  files?: ProjectFile[];
+  rerankFiles?: number;
+  toolResults?: ContentMessageItemToolResult[];
+  attachments?: Attachment[];
+  beforeCommit?: string;
+  workingDirectory?: string;
+
+  // Code options
+  builderContent?: BuilderContent;
+  framework?: CodeGenFramework;
+  styleLibrary?: CodeGenStyleLibrary;
+  typescript?: boolean;
+  userContext?: UserContext;
+
+  enabledTools?: CodeGenTools[];
+
+  // Options
+  maxTokens?: number;
+  maxPages?: number;
+  autoContinue?: number;
+  promptCaching?: boolean;
+  llmSuggestions?: boolean;
+  conclusionText?: boolean;
+
+  searchResponse?: any | null;
+
+  // Prettier options
+  prettierConfig?: PrettierOptions;
+
+  // Role
+  role?: "user" | "agent";
+  user?: UserSource;
+
+  /** @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"
+    | "no-file-for-diff"
+    | "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"
+    | "server_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;
+  isCustomInstruction: boolean;
+}
+
+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;
+  attachments?: Array<Attachment>;
+  id: string;
+  user: UserSource;
+  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;
+  hasChanges: boolean;
+}
+
+export interface GenerateCompletionStepStart {
+  type: "start";
+  name: string;
+  id: string | undefined;
+  title: string;
+  content: string;
+  filePath?: 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;
+  contextPrompt?: string;
+}
+
+export interface GenerateCompletionStepContinue {
+  type: "continue";
+  id: string;
+  url: string;
+}
+
+export interface CodeGenHealthStatus {
+  devServerRunning: boolean;
+  devServerResponding: boolean;
+  logs: string | undefined;
+  lastInstallFailed: boolean;
+  checkLogs: string;
+  checkPassed: boolean;
+  prompt: string;
+  message: string;
+}
+
+export interface SuggestedActionBase {
+  level: "info" | "warning" | "error";
+  canAutoApply: boolean;
+  actionButtonText: string;
+  message: string;
+  userMessage: GenerateUserMessage;
+}
+
+export interface SuggestedActionBuildError extends SuggestedActionBase {
+  type: "build-error";
+  healthStatus: CodeGenHealthStatus;
+}
+
+export type SuggestedAction = SuggestedActionBuildError;
+
+export interface GenerateCompletionStepWaitForInput {
+  type: "wait-for-input";
+  state: GenerateCompletionState;
+  suggestion?: SuggestedAction;
+}
+
+export interface GenerateCompletionStepAbort {
+  type: "user-abort";
+}
+
+export interface GenerateCompletionStepRestore {
+  type: "restore";
+  location: "before" | "after";
+  files: string[];
+  lastCompletionId: string | undefined;
+  commitHash: string | undefined;
+}
+
+export type GenerateCompletionState =
+  | "unknown"
+  | "initial-with-url"
+  | "initial-without-url"
+  | "generating"
+  | "success"
+  | "abort"
+  | "error"
+  | "close"
+  | "replay";
+
+export interface GenerateCompletionStepState {
+  type: "state";
+  previousState: GenerateCompletionState;
+  newState: GenerateCompletionState;
+}
+
+export interface GenerateCompletionStepGit {
+  type: "git";
+  isSessionDirty: boolean;
+  remoteBranchExists: boolean;
+  canPush: boolean;
+  canPull: boolean;
+  canSync: boolean;
+  ahead: number;
+  behind: number;
+  currentCommit: string;
+  currentBranch: string;
+  remoteBranch: string;
+}
+
+export interface GenerateCompletionStepClose {
+  type: "close";
+}
+
+export interface GenerateCompletionStepStdio {
+  type: "stdio";
+  command: string;
+  stream: "stdout" | "stderr";
+  source: "run-command" | "tool-command";
+  content: string;
+}
+
+export interface GenerateCompletionStepSession {
+  type: "session";
+  title: string | undefined;
+  beforeCommit: string | undefined;
+  createdUnixTime: number;
+  updatedUnixTime: number;
+  id: string;
+  hasChanges: boolean;
+}
+
+export interface GenerateCompletionStepServerToolResult {
+  type: "server_tool_result";
+  content: any;
+  title: string;
+  id: string;
+}
+
+export type GenerateCompletionStep = { timestamp?: number } & (
+  | GenerateCompletionStepPlanning
+  | GenerateCompletionStepStart
+  | GenerateCompletionStepDelta
+  | GenerateCompletionStepUser
+  | GenerateCompletionStepFile
+  | GenerateCompletionStepDiff
+  | GenerateCompletionStepTool
+  | GenerateCompletionStepError
+  | GenerateCompletionStepContinue
+  | GenerateCompletionStepWaitForInput
+  | GenerateCompletionStepAbort
+  | GenerateCompletionStepDone
+  | GenerateCompletionStepUserInput
+  | GenerateCompletionStepText
+  | GenerateCompletionStepRestore
+  | GenerateCompletionStepState
+  | GenerateCompletionStepStdio
+  | GenerateCompletionStepSession
+  | GenerateCompletionStepServerToolResult
+  | GenerateCompletionStepGit
+  | GenerateCompletionStepToolResult
+);
+
+export interface ApplyActionsResult {
+  filePath: string;
+  addedLines: number;
+  removedLines: number;
+  action: "create" | "update" | "delete";
+  content?: string;
+  oldContent?: string;
+}
+
+export interface UserSourceBuilder {
+  source: "builder.io";
+  userId?: string;
+  userName?: string;
+  userEmail?: string;
+  role: "user";
+}
+
+export interface UserSourceGithub {
+  source: "github";
+  userName: string;
+  link?: string;
+  role: "user" | "agent";
+}
+
+export interface UserSourceAgent {
+  source: "agent";
+  role: "agent";
+}
+
+export type UserSource = UserSourceBuilder | UserSourceGithub | UserSourceAgent;
+
+export interface GenerateUserMessage {
+  user?: UserSource;
+  userPrompt: string;
+  ephemeralUserPrompt?: string;
+  displayPrompt?: string;
+  files?: string[];
+  includeBaseFiles?: boolean;
+  skipSearch?: boolean;
+  attachments?: Attachment[];
+  debugMode?: boolean;
+  logsCheckpoint?: boolean;
+  dropAbortedPrompt?: boolean;
+}
+
+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;
+  user: UserSource;
+  actions: ActionItem[];
+  sentiment: "positive" | "negative" | "undo" | undefined;
+  applyResults: ApplyActionsResult[];
+  userMessage: GenerateUserMessage | undefined;
+  beforeCommit: string | undefined;
+  afterCommit: string | undefined;
+}
+
+export interface GetSessionTurnsResult {
+  turns: CodegenTurn[];
+  sessionId: string;
+  initialUrl: string | undefined;
+  beforeCommit: string | undefined;
+  title: string | undefined;
+  createdUnixTime: number | undefined;
+  updatedUnixTime: number | undefined;
+}
+
+export interface CodegenFeedback {
+  id: string;
+  feedbackText?: string;
+  feedbackSentiment?: string;
+  framework?: string;
+  acceptedLines?: number;
+  afterCommit?: string;
+}
+
+export interface CodegenSetLastCompletion {
+  sessionId: string;
+  lastCompletionId: string | undefined;
+}
+
+export interface GenerateCodeEventDone {
+  type: "done";
+  unixTime: number;
+  stopReason: CompletionStopReason;
+  id: string;
+  actionTitle: string;
+  content?: string;
+  needsPagination: boolean;
+  actions?: ActionItem[];
+  suggestions: PromptSuggestion[];
+  usage?: CodegenUsage;
+  messageIndex: number;
+  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;
+  user: UserSource;
+  /** @deprecated */
+  role: "user" | "agent";
+}
+
+export type GenerateCodeEvent =
+  | ActionItem
+  | GenerateCodeEventDone
+  | GenerateCodeEventContinue
+  | GenerateCodeEventPagination
+  | GenerateCodeEventDelta
+  | GenerateCodeEventError
+  | GenerateCodeEventUser;