@builder.io/ai-utils 0.3.11 → 0.3.12

package/src/mapping.ts

@@ -0,0 +1,98 @@
+import type { ESMImport } from "./codegen";
+
+export interface RawFigmaJson {
+  documents: any[];
+  document?: any;
+  components?: Record<string, any>;
+  styles?: Record<string, any>;
+  componentSets?: Record<string, any>;
+  schemaVersion?: number;
+}
+
+export interface UserContext {
+  client: string;
+  clientVersion: string;
+  nodeVersion: string;
+  systemPlatform: string;
+  frameworks: string[];
+  systemEOL: string;
+  systemArch: string;
+  systemShell?: string;
+  inGitRepo?: boolean;
+  [key: string]: string | string[] | boolean | undefined;
+}
+
+export type ExportType = "default" | "named";
+
+/**
+ * Gets the latest component mappings for a space
+ */
+export interface FigmaMappingsData {
+  id: string;
+  figmaBuilderLinks: FigmaBuilderLink[];
+  framework: string;
+  version?: number;
+  createdDate?: string; // ISO string timestamp or unix timestamp
+  local: boolean;
+  userEmail?: string;
+  remoteUrl?: string;
+}
+
+export interface FigmaBuilderLink {
+  builderName: string;
+  figmaName: string;
+  figmaKey: string;
+  figmaUrl?: string;
+  inputMapper?: string;
+  originalInputMapper?: string;
+  exportType?: ExportType;
+  importName?: string;
+  importPath?: string;
+  source: string;
+  loc?: string;
+  imports?: ESMImport[];
+}
+
+export interface FigmaMapperFile {
+  filePath: string;
+  content: string;
+}
+
+export interface PublishedMapping {
+  figmaBuilderLinks: FigmaBuilderLink[];
+  mapperFiles: FigmaMapperFile[];
+
+  // Meta data
+  remoteUrl?: string;
+  defaultBranch?: string;
+  currentBranch?: string;
+  commit?: string;
+  spaceKind?: string;
+
+  userContext?: UserContext;
+}
+
+export interface FigmaComponentInfo {
+  documentName: string;
+  key: string;
+  tree?: string;
+  jsx?: string;
+  type: string;
+  name: string;
+  exportJson?: any;
+  inputs: FigmaComponentInput[];
+  description: string;
+  documentationLinks: string[];
+  instanceId: string;
+}
+
+export interface FigmaComponentInput {
+  id: string;
+  name: string;
+  value?: any;
+  type: string;
+  baseType: "text" | "variant" | "boolean" | "slot";
+  variantOptions?: string[];
+  isDefault: boolean;
+  ref?: string;
+}

package/src/messages.ts

@@ -0,0 +1,345 @@
+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;
+  citations?: TextCitationParam[] | null;
+  ephemeral?: boolean;
+}
+
+export interface ContentMessageItemImage {
+  type: "image";
+  source: ImageBase64Source | ImageUrlSource;
+  cache?: boolean;
+  ephemeral?: boolean;
+}
+
+export interface ContentMessageItemDocument {
+  type: "document";
+  source: DocumentBase64Source | DocumentUrlSource;
+  cache?: boolean;
+  ephemeral?: 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;
+  ephemeral?: 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 interface CitationCharLocationParam {
+  cited_text: string;
+
+  document_index: number;
+
+  document_title: string | null;
+
+  end_char_index: number;
+
+  start_char_index: number;
+
+  type: "char_location";
+}
+
+export interface CitationContentBlockLocationParam {
+  cited_text: string;
+
+  document_index: number;
+
+  document_title: string | null;
+
+  end_block_index: number;
+
+  start_block_index: number;
+
+  type: "content_block_location";
+}
+
+export interface CitationPageLocationParam {
+  cited_text: string;
+
+  document_index: number;
+
+  document_title: string | null;
+
+  end_page_number: number;
+
+  start_page_number: number;
+
+  type: "page_location";
+}
+
+export interface CitationWebSearchResultLocationParam {
+  cited_text: string;
+
+  encrypted_index: string;
+
+  title: string | null;
+
+  type: "web_search_result_location";
+
+  url: string;
+}
+
+export type TextCitationParam =
+  | CitationCharLocationParam
+  | CitationPageLocationParam
+  | CitationContentBlockLocationParam
+  | CitationWebSearchResultLocationParam;
+
+export interface ServerToolUseContent {
+  type: "web_search_result";
+  title: string;
+  url: string;
+  page_age: string | null;
+  encrypted_content: string;
+}
+
+export interface ServerToolUseContentError {
+  error_code:
+    | "invalid_tool_input"
+    | "unavailable"
+    | "max_uses_exceeded"
+    | "too_many_requests"
+    | "query_too_long";
+
+  type: "web_search_tool_result_error";
+}
+
+export type ServerToolUseContentUnion =
+  | ServerToolUseContent[]
+  | ServerToolUseContentError;
+
+export interface ContentMessageItemServerToolUse {
+  type: "server_tool_use";
+  id: string;
+  name: "web_search";
+  input: unknown;
+  completion?: string;
+  content?: ServerToolUseContentUnion;
+}
+
+export interface ContentMessageItemWebSearchToolResult {
+  content: ServerToolUseContent[] | ServerToolUseContentError;
+  tool_use_id: string;
+  type: "web_search_tool_result";
+}
+
+export type ContentMessageItem =
+  | ContentMessageItemText
+  | ContentMessageItemImage
+  | ContentMessageItemDocument
+  | ContentMessageItemThinking
+  | ContentMessageItemRedactedThinking
+  | ContentMessageItemToolUse
+  | ContentMessageItemToolResult
+  | ContentMessageItemWebSearchToolResult
+  | ContentMessageItemServerToolUse;
+
+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;
+}