@builder.io/ai-utils 0.17.2 → 0.18.0

package/package.json

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

package/src/codegen.d.ts

@@ -44,6 +44,7 @@ export interface CustomAgentDefinition {
     needDevServer?: boolean;
     needValidation?: boolean;
     includeMemories?: boolean;
+    resetAfterRun?: boolean;
 }
 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;
@@ -349,7 +350,7 @@ export interface CodeGenInputOptions {
     /** @deprecated */
     systemReminderPrompt?: string;
 }
-export type CodeGenErrorCodes = "credits-limit-daily" | "credits-limit-monthly" | "credits-limit-other" | "cli-genetic-error" | "git-update-error" | "prompt-too-long" | "context-too-long" | "abrupt-end" | "unknown" | "failed-recover-state" | "completion-expired" | "ask-to-continue" | "bad-initial-url" | "invalid-last-message" | "corrupted-session" | "privacy-mode-key-required" | "privacy-mode-key-invalid" | "cli-network-error" | "assertion" | "rate-limit" | "unknown-design-system";
+export type CodeGenErrorCodes = "credits-limit-daily" | "credits-limit-monthly" | "credits-limit-other" | "cli-genetic-error" | "git-update-error" | "prompt-too-long" | "context-too-long" | "abrupt-end" | "unknown" | "failed-recover-state" | "completion-expired" | "ask-to-continue" | "bad-initial-url" | "bad-smart-export-payload" | "invalid-last-message" | "corrupted-session" | "privacy-mode-key-required" | "privacy-mode-key-invalid" | "cli-network-error" | "assertion" | "rate-limit" | "unknown-design-system";
 export interface CodegenUsage {
     total: number;
     fast: number;
@@ -750,6 +751,7 @@ export type UserSourcePermission = "editCode" | "modifyMcpServers" | "modifyProj
 export interface UserSourceBase {
     role: "user" | "agent";
     principals?: string[];
+    jobs?: string[];
     permissions?: UserSourcePermission[];
 }
 export interface UserSourceOther extends UserSourceBase {

package/src/completion.d.ts

@@ -1,154 +1,158 @@
-import type { BuilderContent, BuilderElement, Component } from "@builder.io/sdk";
+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[];
+	/**
+	 * 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>;
-    styleInspirationURL?: string;
-    /**
-     * All targeting attributes of the content.
-     */
-    allTargetingAttributes?: Record<string, any>;
+	/**
+	 * 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>;
+	styleInspirationURL?: string;
+	/**
+	 * All targeting attributes of the content.
+	 */
+	allTargetingAttributes?: Record<string, any>;
 }