@builder.io/ai-utils 0.0.1

package/README.md

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

package/dist/complete-json.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Complete a partial JSON string with the necessary closing brackets and braces
+ */
+export declare function completeJson(input: string): string;

package/dist/complete-json.js

@@ -0,0 +1,52 @@
+/**
+ * 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;
+}

package/dist/completion.d.ts

@@ -0,0 +1,64 @@
+import type { BuilderElement, Component } from "@builder.io/sdk";
+import type { MessageParam } from "./messages";
+export type { 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;
+    /**
+     * Tools that the assistant can use to interact with the builder app,
+     * such as "createModel".
+     */
+    tools?: ToolName[];
+    /**
+     * 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 user message to submit to the assistant.
+     */
+    messages: MessageParam[];
+    /**
+     * 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;
+    /**
+     * Builder custom components.
+     */
+    builderComponents?: Component[];
+    /**
+     * Builder design tokens.
+     */
+    builderDesignTokens?: Record<string, string>;
+    /**
+     * Builder element.
+     */
+    builderElement?: BuilderElement;
+    /**
+     * Selected ids in the builder.
+     */
+    builderSelectedIds?: string[];
+    /**
+     * Builder space id.
+     */
+    builderSpaceId?: string;
+    /**
+     * Additional console logs
+     */
+    debug?: boolean;
+}
+export type ToolName = "editContent" | "editModel" | "createModel";

package/dist/completion.js

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

package/dist/events.d.ts

@@ -0,0 +1,190 @@
+import type { BuilderElement, Component } from "@builder.io/sdk";
+import type { Thread } from "./thread";
+import type { AssistantMessage } from "./messages";
+export type BuilderAssistantEventHandler = (ev: BuilderAssistantEvent) => void;
+export type BuilderAssistantEvent = AppCloseEvent | AppMessagesClickEvent | AppMessagesGenerationEvent | AppPromptFocusEvent | AppPromptTextEvent | AppReadyEvent | AppSettingsResetEvent | AppSettingsSetEvent | AppThreadNewEvent | BuiderEditorStateEvent | ContentCreateEvent | ContentUpdateEvent | ContentCompleteEvent | ModelCreateEvent | ModelUpdateEvent | ResultEvent | ThreadCreatedEvent | ThreadMessageDeltaEvent | ThreadMessageCompletedEvent | ThreadMessageFeedbackEvent | ThreadRunRequiresActionEvent | ThreadRunStepCreatedEvent | ThreadRunStepDeltaEvent;
+export interface AppCloseEvent {
+    type: "assistant.app.close";
+}
+export interface AppMessagesClickEvent {
+    type: "assistant.app.messages.click";
+}
+export interface AppMessagesGenerationEvent {
+    type: "assistant.app.messages.generation";
+    data: {
+        state: GenerationState;
+    };
+}
+/**
+ * idle - no messages are being generated or queued to be generated
+ * queued - messages have been sent, but no response has been received yet
+ * generating - messages are actively being generated
+ */
+export type GenerationState = "idle" | "queued" | "generating";
+export interface AppPromptFocusEvent {
+    type: "assistant.app.prompt.focus";
+}
+export interface AppPromptTextEvent {
+    type: "assistant.app.prompt.text";
+    data: {
+        text: string;
+    };
+}
+export interface AppReadyEvent {
+    type: "assistant.app.ready";
+}
+export interface AppSettingsResetEvent {
+    type: "assistant.app.settings.reset";
+}
+export interface AppSettingsSetEvent<T = any> {
+    type: "assistant.app.settings.set";
+    data: DeepPartial<T>;
+}
+export interface AppThreadNewEvent {
+    type: "assistant.app.thread.new";
+}
+export interface BuiderEditorStateEvent extends AwaitResultEvent {
+    type: "assistant.editor.state";
+}
+export interface AwaitResultEvent {
+    resolveId?: string;
+}
+export interface ResultEvent {
+    type: "assistant.result";
+    resolveId: string;
+    data: any;
+}
+export interface BuiderEditorState {
+    components?: Component[];
+    designTokens?: Record<string, string>;
+    element?: BuilderElement | undefined;
+    selectedIds?: string[];
+    spaceId?: string | undefined;
+}
+export interface ContentCreateEvent {
+    type: "assistant.content.create";
+    data: ContentCreatePatch;
+}
+export interface ContentCreatePatch {
+    parentId: string;
+    insertBeforeId: string;
+    element: BuilderElement;
+}
+export interface ContentUpdateEvent {
+    type: "assistant.content.update";
+    data: ContentUpdatePatch;
+}
+export type ContentUpdatePatch = ContentPropsUpdatePatch | ContentStyleUpdatePatch | ContentTextUpdatePatch;
+export interface ContentPropsUpdatePatch {
+    type: "props";
+    id: string;
+    value: Record<string, any>;
+}
+export interface ContentStyleUpdatePatch {
+    type: "style";
+    id: string;
+    value: Record<string, any>;
+}
+export interface ContentTextUpdatePatch {
+    type: "content";
+    id: string;
+    value: string;
+}
+export interface ContentCompleteEvent {
+    type: "assistant.content.complete";
+    data: ContentComplete;
+}
+export interface ContentComplete {
+    threadId: string;
+    message: AssistantMessage;
+}
+export interface ModelCreateEvent {
+    type: "assistant.model.create";
+    data: DeepPartial<ModelInfo>;
+}
+export interface ModelUpdateEvent {
+    type: "assistant.model.update";
+    data: ModelUpdate;
+}
+export interface ModelUpdate {
+    patches: ModelPatch[];
+}
+export type ModelInfo = {
+    name: string;
+    description: string;
+    type: string;
+    fields: {
+        name: string;
+        type: string;
+    }[];
+};
+export type ModelPatch = {
+    op: "add" | "remove" | "replace";
+    path: string;
+    value?: any;
+};
+export interface ThreadMessageFeedbackEvent {
+    type: "assistant.thread.message.feedback";
+    data: ThreadMessageFeedback;
+}
+export interface ThreadMessageFeedback {
+    /**
+     * Same as "id" of message
+     */
+    messageId: string;
+    userId: string;
+    feedbackText: string;
+    thread: Thread;
+    platformId: string;
+    sentiment?: "positive" | "negative";
+}
+export interface ThreadCreatedEvent {
+    type: "assistant.thread.created";
+    data: ThreadCreated;
+}
+export interface ThreadCreated {
+    platformId: string;
+    threadId: string;
+    vectorStoreId: string;
+}
+export interface ThreadMessageDeltaEvent {
+    type: "assistant.thread.message.delta";
+    data: ThreadMessageDelta;
+}
+export interface ThreadMessageDelta {
+    text: string;
+}
+export interface ThreadMessageCompletedEvent {
+    type: "assistant.thread.message.completed";
+    data: ThreadMessageCompleted;
+}
+export interface ThreadMessageCompleted {
+    platformId: string;
+    threadId: string;
+    message: AssistantMessage;
+}
+export interface ThreadRunRequiresActionEvent {
+    type: "assistant.thread.run.requires_action";
+    data: ThreadRunRequiredAction;
+}
+export interface ThreadRunRequiredAction {
+    platformId: string;
+    threadId: string;
+    action: {
+        name: string;
+        arguments: string;
+    };
+}
+export interface ThreadRunStepDeltaEvent {
+    type: "assistant.thread.run.step.delta";
+    data: ThreadMessageStepDelta;
+}
+export interface ThreadMessageStepDelta {
+    delta: any;
+}
+export interface ThreadRunStepCreatedEvent {
+    type: "assistant.thread.run.step.created";
+}
+export type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;

package/dist/events.js

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

package/dist/fetch.d.ts

@@ -0,0 +1 @@
+export declare function fetchJsonl<T>(input: string | URL, init: RequestInit, onData: (ev: T) => void): Promise<Response>;

package/dist/fetch.js

@@ -0,0 +1,54 @@
+export async function fetchJsonl(input, init, onData) {
+    return new Promise(async (resolve, reject) => {
+        try {
+            init = {
+                ...init,
+                headers: {
+                    accept: "application/jsonl",
+                    "content-type": "application/json",
+                    ...init.headers,
+                },
+            };
+            const rsp = await fetch(input, init);
+            if (!rsp.ok) {
+                reject(new Error(`${input}, status: ${rsp.status}`));
+                return;
+            }
+            if (!rsp.body) {
+                reject(new Error(`${input}, missing body`));
+                return;
+            }
+            const reader = rsp.body.getReader();
+            const decoder = new TextDecoder();
+            let data = "";
+            const processStream = async () => {
+                const { done, value } = await reader.read();
+                data += decoder.decode(value, { stream: !done });
+                if (!done) {
+                    let lines = data.split("\n");
+                    if (!done) {
+                        data = lines.pop() || "";
+                    }
+                    for (let line of lines) {
+                        if (line) {
+                            try {
+                                onData(JSON.parse(line));
+                            }
+                            catch (e) {
+                                console.error(`Failed to parse JSONL: ${line}`);
+                                reject(e);
+                                return;
+                            }
+                        }
+                    }
+                    await processStream();
+                }
+            };
+            await processStream();
+            resolve(rsp);
+        }
+        catch (e) {
+            reject(e);
+        }
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./complete-json.js";
+export * from "./completion.js";
+export * from "./events.js";
+export * from "./fetch.js";
+export * from "./messages.js";
+export * from "./settings.js";
+export * from "./thread.js";

package/dist/index.js

@@ -0,0 +1,7 @@
+export * from "./complete-json.js";
+export * from "./completion.js";
+export * from "./events.js";
+export * from "./fetch.js";
+export * from "./messages.js";
+export * from "./settings.js";
+export * from "./thread.js";

package/dist/messages.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Message param does not know the id of the message.
+ * This is an input message.
+ */
+export type MessageParam = SystemMessageParam | UserMessageParam | AssistantMessageParam;
+export interface SystemMessageParam {
+    /**
+     * The contents of the system message.
+     */
+    content: 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;
+    /**
+     * 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;
+    /**
+     * The role of the messages author, in this case `assistant`.
+     */
+    role: "assistant";
+    /**
+     * The function call name and arguments
+     */
+    action?: {
+        /**
+         * The specific function name
+         */
+        name: string;
+        /** This is arbitrary JSON */
+        arguments: any;
+    };
+    id?: string;
+}
+export interface SystemMessage extends SystemMessageParam {
+    id: string;
+}
+export interface UserMessage extends UserMessageParam {
+    id: string;
+}
+export interface AssistantMessage extends AssistantMessageParam {
+    id: 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> & {
+    generating?: boolean;
+});

package/dist/messages.js

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

package/dist/settings.d.ts

@@ -0,0 +1,16 @@
+export interface AssistantSettings {
+    assistantType?: string;
+    hideFrameworkPicker?: boolean;
+    messagePlaceholder: string;
+    hideHeader?: boolean;
+    headingText: string;
+    cssOverrides?: string;
+    showCloseButton?: boolean;
+    showSparklesInInputBar?: boolean;
+    suggestedItems: {
+        text: string;
+        prompt: string;
+        icon: any;
+        iconColor?: string;
+    }[];
+}

package/dist/settings.js

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

package/dist/thread.d.ts

@@ -0,0 +1,16 @@
+import type { Message } from "./messages";
+export interface Thread {
+    /**
+     * The unique LOCAL identifier of the thread.
+     */
+    id: string;
+    /**
+     * The unique OPENAI identifier of the thread. This is only
+     * set after openai creates the thread.
+     */
+    threadId?: string;
+    platformId?: string;
+    title?: string;
+    created: number;
+    messages: Message[];
+}

package/dist/thread.js

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

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@builder.io/ai-utils",
+  "version": "0.0.1",
+  "description": "Builder.io AI utils",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@builder.io/sdk": "^2.2.4"
+  }
+}