@builder.io/ai-utils 0.3.0 → 0.3.2

package/src/codegen.ts

@@ -1,517 +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";
-
-// 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" | 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" // @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;
-  displayUserPrompt?: string;
-  files?: ProjectFile[];
-  rerankFiles?: number;
-  toolResults?: ContentMessageItemToolResult[];
-  attachments?: Attachment[];
-  beforeCommit?: string;
-
-  // Code options
-  builderContent?: BuilderContent;
-  framework?: CodeGenFramework;
-  styleLibrary?: CodeGenStyleLibrary;
-  typescript?: boolean;
-  userContext?: UserContext;
-
-  enabledTools?: CodeGenTools[];
-
-  // Options
-  maxTokens?: number;
-  maxPages?: number;
-  autoContinue?: number;
-  promptCaching?: boolean;
-  isAutoContinue?: boolean;
-  llmSuggestions?: boolean;
-  conclusionText?: boolean;
-
-  searchResponse?: any | null;
-
-  // Prettier options
-  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";
-  state: GenerateCompletionState;
-}
-
-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";
-
-export interface GenerateCompletionStepState {
-  type: "state";
-  previousState: GenerateCompletionState;
-  newState: GenerateCompletionState;
-}
-
-export interface GenerateCompletionStepClose {
-  type: "close";
-}
-
-export type GenerateCompletionStep = { timestamp?: number } & (
-  | GenerateCompletionStepPlanning
-  | GenerateCompletionStepStart
-  | GenerateCompletionStepDelta
-  | GenerateCompletionStepUser
-  | GenerateCompletionStepFile
-  | GenerateCompletionStepDiff
-  | GenerateCompletionStepTool
-  | GenerateCompletionStepError
-  | GenerateCompletionStepContinue
-  | GenerateCompletionStepWaitForInput
-  | GenerateCompletionStepAbort
-  | GenerateCompletionStepDone
-  | GenerateCompletionStepUserInput
-  | GenerateCompletionStepText
-  | GenerateCompletionStepRestore
-  | GenerateCompletionStepState
-  | 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 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;
-  role: "user" | "agent";
-}
-
-export type GenerateCodeEvent =
-  | ActionItem
-  | GenerateCodeEventDone
-  | GenerateCodeEventContinue
-  | GenerateCodeEventPagination
-  | GenerateCodeEventDelta
-  | GenerateCodeEventError
-  | GenerateCodeEventUser;

package/src/completion.ts

@@ -1,174 +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>;
-
-  // A URL to use as design inspiration when generating content
-  styleInspirationURL?: string;
-
-  /**
-   * All targeting attributes of the content.
-   */
-  allTargetingAttributes?: Record<string, any>;
-}