@convex-dev/agent 0.5.0-alpha.1 → 0.6.0-alpha.1

package/dist/client/start.js

@@ -0,0 +1,185 @@
+import { stepCountIs, } from "ai";
+import { serializeNewMessagesInStep, serializeObjectResult, } from "../mapping.js";
+import { embedMessages, fetchContextWithPrompt } from "./search.js";
+import { getModelName, getProviderName, } from "../shared.js";
+import { wrapTools } from "./createTool.js";
+import { assert, omit } from "convex-helpers";
+import { saveInputMessages } from "./saveInputMessages.js";
+export async function startGeneration(ctx, component, 
+/**
+ * These are the arguments you'll pass to the LLM call such as
+ * `generateText` or `streamText`. This function will look up the context
+ * and provide functions to save the steps, abort the generation, and more.
+ * The type of the arguments returned infers from the type of the arguments
+ * you pass here.
+ */
+args, { threadId, ...opts }) {
+    const userId = opts.userId ??
+        (threadId &&
+            (await ctx.runQuery(component.threads.getThread, { threadId }))
+                ?.userId) ??
+        undefined;
+    const context = await fetchContextWithPrompt(ctx, component, {
+        ...opts,
+        userId,
+        threadId,
+        messages: args.messages,
+        prompt: args.prompt,
+        promptMessageId: args.promptMessageId,
+    });
+    const saveMessages = opts.storageOptions?.saveMessages ?? "promptAndOutput";
+    const { promptMessageId, pendingMessage, savedMessages } = threadId && saveMessages !== "none"
+        ? await saveInputMessages(ctx, component, {
+            ...opts,
+            userId,
+            threadId,
+            prompt: args.prompt,
+            messages: args.messages,
+            promptMessageId: args.promptMessageId,
+            storageOptions: { saveMessages },
+        })
+        : {
+            promptMessageId: args.promptMessageId,
+            pendingMessage: undefined,
+            savedMessages: [],
+        };
+    const order = pendingMessage?.order ?? context.order;
+    const stepOrder = pendingMessage?.stepOrder ?? context.stepOrder;
+    let pendingMessageId = pendingMessage?._id;
+    const model = args.model ?? opts.languageModel;
+    assert(model, "model is required");
+    let activeModel = model;
+    const fail = async (reason) => {
+        if (pendingMessageId) {
+            await ctx.runMutation(component.messages.finalizeMessage, {
+                messageId: pendingMessageId,
+                result: { status: "failed", error: reason },
+            });
+        }
+    };
+    if (args.abortSignal) {
+        const abortSignal = args.abortSignal;
+        abortSignal.addEventListener("abort", async () => {
+            await fail(abortSignal.reason?.toString() ?? "abortSignal");
+        }, { once: true });
+    }
+    const toolCtx = {
+        ...ctx,
+        userId,
+        threadId,
+        promptMessageId,
+        agent: opts.agentForToolCtx,
+    };
+    const tools = wrapTools(toolCtx, args.tools);
+    const aiArgs = {
+        ...opts.callSettings,
+        providerOptions: opts.providerOptions,
+        ...omit(args, ["promptMessageId", "messages", "prompt"]),
+        model,
+        messages: context.messages,
+        stopWhen: args.stopWhen ?? (opts.maxSteps ? stepCountIs(opts.maxSteps) : undefined),
+        tools,
+    };
+    // NOTE: We intentionally do NOT override _internal.generateId here.
+    // The AI SDK uses generateId() for many internal IDs (approval IDs,
+    // tool execution IDs, message IDs, etc.) and they must be unique.
+    // The pending message is linked via the explicit `pendingMessageId`
+    // parameter passed to addMessages in the save closure.
+    // Track how many response messages we've already saved across steps.
+    // step.response.messages is cumulative — each step appends to it.
+    // We need to know which messages are new in each step to serialize
+    // only the new ones (important for tool approval flows where the SDK
+    // may add extra messages like approval tool-results).
+    let previousResponseMessageCount = 0;
+    return {
+        args: aiArgs,
+        order: order ?? 0,
+        stepOrder: stepOrder ?? 0,
+        userId,
+        promptMessageId,
+        getSavedMessages: () => savedMessages,
+        updateModel: (model) => {
+            if (model) {
+                activeModel = model;
+            }
+        },
+        fail,
+        save: async (toSave, createPendingMessage, 
+        /**
+         * If provided, finish this stream atomically with the message save.
+         * This prevents UI flickering from separate mutations (issue #181).
+         */
+        finishStreamId) => {
+            if (threadId && saveMessages !== "none") {
+                let serialized;
+                if ("object" in toSave) {
+                    serialized = await serializeObjectResult(ctx, component, toSave.object, activeModel);
+                }
+                else {
+                    const allResponseMessages = toSave.step.response.messages;
+                    const newResponseMessages = allResponseMessages.slice(previousResponseMessageCount);
+                    previousResponseMessageCount = allResponseMessages.length;
+                    serialized = await serializeNewMessagesInStep(ctx, component, toSave.step, activeModel, newResponseMessages);
+                }
+                const embeddings = await embedMessages(ctx, { threadId, ...opts, userId }, serialized.messages.map((m) => m.message));
+                if (createPendingMessage) {
+                    serialized.messages.push({
+                        message: { role: "assistant", content: [] },
+                        status: "pending",
+                    });
+                    embeddings?.vectors.push(null);
+                }
+                const saved = await ctx.runMutation(component.messages.addMessages, {
+                    userId,
+                    threadId,
+                    agentName: opts.agentName,
+                    promptMessageId,
+                    pendingMessageId,
+                    messages: serialized.messages,
+                    embeddings,
+                    failPendingSteps: false,
+                    finishStreamId,
+                });
+                const lastMessage = saved.messages.at(-1);
+                if (createPendingMessage) {
+                    if (lastMessage.status === "failed") {
+                        pendingMessageId = undefined;
+                        savedMessages.push(...saved.messages);
+                        await fail(lastMessage.error ??
+                            "Aborting - the pending message was marked as failed");
+                    }
+                    else {
+                        pendingMessageId = lastMessage._id;
+                        savedMessages.push(...saved.messages.slice(0, -1));
+                    }
+                }
+                else {
+                    pendingMessageId = undefined;
+                    savedMessages.push(...saved.messages);
+                }
+            }
+            const output = "object" in toSave ? toSave.object : toSave.step;
+            if (opts.rawRequestResponseHandler) {
+                await opts.rawRequestResponseHandler(ctx, {
+                    userId,
+                    threadId,
+                    agentName: opts.agentName,
+                    request: output.request,
+                    response: output.response,
+                });
+            }
+            if (opts.usageHandler && output.usage) {
+                await opts.usageHandler(ctx, {
+                    userId,
+                    threadId,
+                    agentName: opts.agentName,
+                    model: getModelName(activeModel),
+                    provider: getProviderName(activeModel),
+                    usage: output.usage,
+                    providerMetadata: output.providerMetadata,
+                });
+            }
+        },
+    };
+}
+//# sourceMappingURL=start.js.map

package/dist/client/start.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.js","sourceRoot":"","sources":["../../src/client/start.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,GASZ,MAAM,IAAI,CAAC;AACZ,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,GACtB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAGpE,OAAO,EACL,YAAY,EACZ,eAAe,GAEhB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,SAAS,EAAgB,MAAM,iBAAiB,CAAC;AAE1D,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG3D,MAAM,CAAC,KAAK,UAAU,eAAe,CAKnC,GAA0B,EAC1B,SAAyB;AACzB;;;;;;GAMG;AACH,IAyCC,EACD,EACE,QAAQ,EACR,GAAG,IAAI,EAQN;IAwBH,MAAM,MAAM,GACV,IAAI,CAAC,MAAM;QACX,CAAC,QAAQ;YACP,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC7D,EAAE,MAAM,CAAC;QACb,SAAS,CAAC;IAEZ,MAAM,OAAO,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,SAAS,EAAE;QAC3D,GAAG,IAAI;QACP,MAAM;QACN,QAAQ;QACR,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,eAAe,EAAE,IAAI,CAAC,eAAe;KACtC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,EAAE,YAAY,IAAI,iBAAiB,CAAC;IAC5E,MAAM,EAAE,eAAe,EAAE,cAAc,EAAE,aAAa,EAAE,GACtD,QAAQ,IAAI,YAAY,KAAK,MAAM;QACjC,CAAC,CAAC,MAAM,iBAAiB,CAAC,GAAG,EAAE,SAAS,EAAE;YACtC,GAAG,IAAI;YACP,MAAM;YACN,QAAQ;YACR,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,cAAc,EAAE,EAAE,YAAY,EAAE;SACjC,CAAC;QACJ,CAAC,CAAC;YACE,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,cAAc,EAAE,SAAS;YACzB,aAAa,EAAE,EAAkB;SAClC,CAAC;IAER,MAAM,KAAK,GAAG,cAAc,EAAE,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC;IACrD,MAAM,SAAS,GAAG,cAAc,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC;IACjE,IAAI,gBAAgB,GAAG,cAAc,EAAE,GAAG,CAAC;IAE3C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC;IAC/C,MAAM,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;IACnC,IAAI,WAAW,GAAoB,KAAK,CAAC;IAEzC,MAAM,IAAI,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;QACpC,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE;gBACxD,SAAS,EAAE,gBAAgB;gBAC3B,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE;aAC5C,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,WAAW,CAAC,gBAAgB,CAC1B,OAAO,EACP,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,aAAa,CAAC,CAAC;QAC9D,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG;QACd,GAAI,GAAsD;QAC1D,MAAM;QACN,QAAQ;QACR,eAAe;QACf,KAAK,EAAE,IAAI,CAAC,eAAe;KACV,CAAC;IACpB,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAU,CAAC;IACtD,MAAM,MAAM,GAAG;QACb,GAAG,IAAI,CAAC,YAAY;QACpB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,iBAAiB,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;QACxD,KAAK;QACL,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,QAAQ,EACN,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,KAAK;KAOS,CAAC;IACjB,oEAAoE;IACpE,oEAAoE;IACpE,kEAAkE;IAClE,oEAAoE;IACpE,uDAAuD;IACvD,qEAAqE;IACrE,kEAAkE;IAClE,mEAAmE;IACnE,qEAAqE;IACrE,sDAAsD;IACtD,IAAI,4BAA4B,GAAG,CAAC,CAAC;IAErC,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,KAAK,IAAI,CAAC;QACjB,SAAS,EAAE,SAAS,IAAI,CAAC;QACzB,MAAM;QACN,eAAe;QACf,gBAAgB,EAAE,GAAG,EAAE,CAAC,aAAa;QACrC,WAAW,EAAE,CAAC,KAAkC,EAAE,EAAE;YAClD,IAAI,KAAK,EAAE,CAAC;gBACV,WAAW,GAAG,KAAK,CAAC;YACtB,CAAC;QACH,CAAC;QACD,IAAI;QACJ,IAAI,EAAE,KAAK,EACT,MAE6C,EAC7C,oBAA8B;QAC9B;;;WAGG;QACH,cAAuB,EACvB,EAAE;YACF,IAAI,QAAQ,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;gBACxC,IAAI,UAAU,CAAC;gBACf,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;oBACvB,UAAU,GAAG,MAAM,qBAAqB,CACtC,GAAG,EACH,SAAS,EACT,MAAM,CAAC,MAAM,EACb,WAAW,CACZ,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;oBAC1D,MAAM,mBAAmB,GAAG,mBAAmB,CAAC,KAAK,CACnD,4BAA4B,CAC7B,CAAC;oBACF,4BAA4B,GAAG,mBAAmB,CAAC,MAAM,CAAC;oBAC1D,UAAU,GAAG,MAAM,0BAA0B,CAC3C,GAAG,EACH,SAAS,EACT,MAAM,CAAC,IAAI,EACX,WAAW,EACX,mBAAmB,CACpB,CAAC;gBACJ,CAAC;gBACD,MAAM,UAAU,GAAG,MAAM,aAAa,CACpC,GAAG,EACH,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAC7B,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAC1C,CAAC;gBACF,IAAI,oBAAoB,EAAE,CAAC;oBACzB,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;wBACvB,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,EAAE;wBAC3C,MAAM,EAAE,SAAS;qBAClB,CAAC,CAAC;oBACH,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACjC,CAAC;gBACD,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE;oBAClE,MAAM;oBACN,QAAQ;oBACR,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,eAAe;oBACf,gBAAgB;oBAChB,QAAQ,EAAE,UAAU,CAAC,QAAQ;oBAC7B,UAAU;oBACV,gBAAgB,EAAE,KAAK;oBACvB,cAAc;iBACf,CAAC,CAAC;gBACH,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC;gBAC3C,IAAI,oBAAoB,EAAE,CAAC;oBACzB,IAAI,WAAW,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;wBACpC,gBAAgB,GAAG,SAAS,CAAC;wBAC7B,aAAa,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;wBACtC,MAAM,IAAI,CACR,WAAW,CAAC,KAAK;4BACf,qDAAqD,CACxD,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,gBAAgB,GAAG,WAAW,CAAC,GAAG,CAAC;wBACnC,aAAa,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;oBACrD,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,gBAAgB,GAAG,SAAS,CAAC;oBAC7B,aAAa,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACxC,CAAC;YACH,CAAC;YACD,MAAM,MAAM,GAAG,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;YAChE,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACnC,MAAM,IAAI,CAAC,yBAAyB,CAAC,GAAG,EAAE;oBACxC,MAAM;oBACN,QAAQ;oBACR,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;iBAC1B,CAAC,CAAC;YACL,CAAC;YACD,IAAI,IAAI,CAAC,YAAY,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACtC,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE;oBAC3B,MAAM;oBACN,QAAQ;oBACR,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,KAAK,EAAE,YAAY,CAAC,WAAW,CAAC;oBAChC,QAAQ,EAAE,eAAe,CAAC,WAAW,CAAC;oBACtC,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;iBAC1C,CAAC,CAAC;YACL,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/client/streamText.d.ts

@@ -0,0 +1,46 @@
+import type { StreamTextResult, ToolSet } from "ai";
+import { streamText as streamTextAi } from "ai";
+import { type StreamingOptions } from "./streaming.js";
+import type { ActionCtx, AgentComponent, AgentPrompt, GenerationOutputMetadata, Options, Output } from "./types.js";
+import type { Agent } from "./index.js";
+/**
+ * This behaves like {@link streamText} from the "ai" package except that
+ * it add context based on the userId and threadId and saves the input and
+ * resulting messages to the thread, if specified.
+ * Use {@link continueThread} to get a version of this function already scoped
+ * to a thread (and optionally userId).
+ */
+export declare function streamText<TOOLS extends ToolSet, OUTPUT extends Output<any, any, any> = never>(ctx: ActionCtx, component: AgentComponent, 
+/**
+ * The arguments to the streamText function, similar to the ai sdk's
+ * {@link streamText} function, along with Agent prompt options.
+ */
+streamTextArgs: AgentPrompt & Omit<Parameters<typeof streamTextAi<TOOLS, OUTPUT>>[0], "model" | "prompt" | "messages"> & {
+    /**
+     * The tools to use for the tool calls. This will override tools specified
+     * in the Agent constructor or createThread / continueThread.
+     */
+    tools?: TOOLS;
+}, 
+/**
+ * The {@link ContextOptions} and {@link StorageOptions}
+ * options to use for fetching contextual messages and saving input/output messages.
+ */
+options: Options & {
+    agentName: string;
+    userId?: string | null;
+    threadId?: string;
+    /**
+     * Whether to save incremental data (deltas) from streaming responses.
+     * Defaults to false.
+     * If false, it will not save any deltas to the database.
+     * If true, it will save deltas with {@link DEFAULT_STREAMING_OPTIONS}.
+     *
+     * Regardless of this option, when streaming you are able to use this
+     * `streamText` function as you would with the "ai" package's version:
+     * iterating over the text, streaming it over HTTP, etc.
+     */
+    saveStreamDeltas?: boolean | StreamingOptions;
+    agentForToolCtx?: Agent;
+}): Promise<StreamTextResult<TOOLS, OUTPUT> & GenerationOutputMetadata>;
+//# sourceMappingURL=streamText.d.ts.map

package/dist/client/streamText.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamText.d.ts","sourceRoot":"","sources":["../../src/client/streamText.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,gBAAgB,EAChB,OAAO,EAER,MAAM,IAAI,CAAC;AACZ,OAAO,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,IAAI,CAAC;AAChD,OAAO,EAIL,KAAK,gBAAgB,EACtB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,SAAS,EACT,cAAc,EACd,WAAW,EACX,wBAAwB,EACxB,OAAO,EACP,MAAM,EACP,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAIxC;;;;;;GAMG;AACH,wBAAsB,UAAU,CAC9B,KAAK,SAAS,OAAO,EACrB,MAAM,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,EAE5C,GAAG,EAAE,SAAS,EACd,SAAS,EAAE,cAAc;AACzB;;;GAGG;AACH,cAAc,EAAE,WAAW,GACzB,IAAI,CACF,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EACjD,OAAO,GAAG,QAAQ,GAAG,UAAU,CAChC,GAAG;IACF;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AACH;;;GAGG;AACH,OAAO,EAAE,OAAO,GAAG;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;IAC9C,eAAe,CAAC,EAAE,KAAK,CAAC;CACzB,GACA,OAAO,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,wBAAwB,CAAC,CA+GrE"}

package/dist/client/streamText.js

@@ -0,0 +1,117 @@
+import { streamText as streamTextAi } from "ai";
+import { compressUIMessageChunks, DeltaStreamer, mergeTransforms, } from "./streaming.js";
+import { startGeneration } from "./start.js";
+import { getModelName, getProviderName } from "../shared.js";
+import { errorToString, willContinue } from "./utils.js";
+/**
+ * This behaves like {@link streamText} from the "ai" package except that
+ * it add context based on the userId and threadId and saves the input and
+ * resulting messages to the thread, if specified.
+ * Use {@link continueThread} to get a version of this function already scoped
+ * to a thread (and optionally userId).
+ */
+export async function streamText(ctx, component, 
+/**
+ * The arguments to the streamText function, similar to the ai sdk's
+ * {@link streamText} function, along with Agent prompt options.
+ */
+streamTextArgs, 
+/**
+ * The {@link ContextOptions} and {@link StorageOptions}
+ * options to use for fetching contextual messages and saving input/output messages.
+ */
+options) {
+    const { threadId } = options ?? {};
+    const { args, userId, order, stepOrder, promptMessageId, ...call } = await startGeneration(ctx, component, streamTextArgs, options);
+    const steps = [];
+    // Track the final step for atomic save with stream finish (issue #181)
+    let pendingFinalStep;
+    const streamer = threadId && options.saveStreamDeltas
+        ? new DeltaStreamer(component, ctx, {
+            throttleMs: typeof options.saveStreamDeltas === "object"
+                ? options.saveStreamDeltas.throttleMs
+                : undefined,
+            onAsyncAbort: call.fail,
+            compress: compressUIMessageChunks,
+            abortSignal: args.abortSignal,
+        }, {
+            threadId,
+            userId,
+            agentName: options?.agentName,
+            model: getModelName(args.model),
+            provider: getProviderName(args.model),
+            providerOptions: args.providerOptions,
+            format: "UIMessageChunk",
+            order,
+            stepOrder,
+        })
+        : undefined;
+    const result = streamTextAi({
+        ...args,
+        abortSignal: streamer?.abortController.signal ?? args.abortSignal,
+        experimental_transform: mergeTransforms(options?.saveStreamDeltas, streamTextArgs.experimental_transform),
+        onError: async (error) => {
+            console.error("onError", error);
+            await call.fail(errorToString(error.error));
+            await streamer?.fail(errorToString(error.error));
+            return streamTextArgs.onError?.(error);
+        },
+        prepareStep: async (options) => {
+            const result = await streamTextArgs.prepareStep?.(options);
+            if (result) {
+                const model = result.model ?? options.model;
+                call.updateModel(model);
+                // streamer?.updateMetadata({
+                //   model: getModelName(model),
+                //   provider: getProviderName(model),
+                //   providerOptions: options.messages.at(-1)?.providerOptions,
+                // });
+                return result;
+            }
+            return undefined;
+        },
+        onStepFinish: async (step) => {
+            steps.push(step);
+            const createPendingMessage = await willContinue(steps, args.stopWhen);
+            if (!createPendingMessage && streamer) {
+                // This is the final step with streaming enabled.
+                // Defer saving until stream consumption completes for atomic finish (issue #181).
+                streamer.markFinishedExternally();
+                pendingFinalStep = step;
+            }
+            else {
+                await call.save({ step }, createPendingMessage);
+            }
+            return args.onStepFinish?.(step);
+        },
+    });
+    const stream = streamer?.consumeStream(result.toUIMessageStream());
+    if ((typeof options?.saveStreamDeltas === "object" &&
+        !options.saveStreamDeltas.returnImmediately) ||
+        options?.saveStreamDeltas === true) {
+        try {
+            await stream;
+            await result.consumeStream();
+        }
+        catch (e) {
+            // If the stream errored (e.g. onStepFinish threw), the DeltaStreamer's
+            // finish() was never called, leaving the streaming message stuck in
+            // "streaming" state. Clean it up by marking it as aborted.
+            await streamer?.fail(e instanceof Error ? e.message : String(e));
+            throw e;
+        }
+    }
+    // If we deferred the final step save, do it now with atomic stream finish.
+    if (pendingFinalStep && streamer) {
+        const finishStreamId = await streamer.getOrCreateStreamId();
+        await call.save({ step: pendingFinalStep }, false, finishStreamId);
+    }
+    const metadata = {
+        promptMessageId,
+        order,
+        savedMessages: call.getSavedMessages(),
+        messageId: promptMessageId,
+    };
+    return Object.assign(result, metadata);
+}
+//# sourceMappingURL=streamText.js.map

package/dist/client/streamText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamText.js","sourceRoot":"","sources":["../../src/client/streamText.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,IAAI,CAAC;AAChD,OAAO,EACL,uBAAuB,EACvB,aAAa,EACb,eAAe,GAEhB,MAAM,gBAAgB,CAAC;AASxB,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEzD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAI9B,GAAc,EACd,SAAyB;AACzB;;;GAGG;AACH,cAUG;AACH;;;GAGG;AACH,OAgBC;IAED,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IACnC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAChE,MAAM,eAAe,CAAC,GAAG,EAAE,SAAS,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;IAEjE,MAAM,KAAK,GAAwB,EAAE,CAAC;IAEtC,uEAAuE;IACvE,IAAI,gBAA+C,CAAC;IAEpD,MAAM,QAAQ,GACZ,QAAQ,IAAI,OAAO,CAAC,gBAAgB;QAClC,CAAC,CAAC,IAAI,aAAa,CACf,SAAS,EACT,GAAG,EACH;YACE,UAAU,EACR,OAAO,OAAO,CAAC,gBAAgB,KAAK,QAAQ;gBAC1C,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU;gBACrC,CAAC,CAAC,SAAS;YACf,YAAY,EAAE,IAAI,CAAC,IAAI;YACvB,QAAQ,EAAE,uBAAuB;YACjC,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,EACD;YACE,QAAQ;YACR,MAAM;YACN,SAAS,EAAE,OAAO,EAAE,SAAS;YAC7B,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC/B,QAAQ,EAAE,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;YACrC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,MAAM,EAAE,gBAAgB;YACxB,KAAK;YACL,SAAS;SACV,CACF;QACH,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,MAAM,GAAG,YAAY,CAAC;QAC1B,GAAG,IAAI;QACP,WAAW,EAAE,QAAQ,EAAE,eAAe,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW;QACjE,sBAAsB,EAAE,eAAe,CACrC,OAAO,EAAE,gBAAgB,EACzB,cAAc,CAAC,sBAAsB,CACtC;QACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YACvB,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YAChC,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5C,MAAM,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YACjD,OAAO,cAAc,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC;QACD,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YAC7B,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC;YAC3D,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC;gBAC5C,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBACxB,6BAA6B;gBAC7B,gCAAgC;gBAChC,sCAAsC;gBACtC,+DAA+D;gBAC/D,MAAM;gBACN,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC3B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,MAAM,oBAAoB,GAAG,MAAM,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtE,IAAI,CAAC,oBAAoB,IAAI,QAAQ,EAAE,CAAC;gBACtC,iDAAiD;gBACjD,kFAAkF;gBAClF,QAAQ,CAAC,sBAAsB,EAAE,CAAC;gBAClC,gBAAgB,GAAG,IAAI,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,oBAAoB,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;KACF,CAAoC,CAAC;IACtC,MAAM,MAAM,GAAG,QAAQ,EAAE,aAAa,CACpC,MAAM,CAAC,iBAAiB,EAAsB,CAC/C,CAAC;IACF,IACE,CAAC,OAAO,OAAO,EAAE,gBAAgB,KAAK,QAAQ;QAC5C,CAAC,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;QAC9C,OAAO,EAAE,gBAAgB,KAAK,IAAI,EAClC,CAAC;QACD,IAAI,CAAC;YACH,MAAM,MAAM,CAAC;YACb,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,uEAAuE;YACvE,oEAAoE;YACpE,2DAA2D;YAC3D,MAAM,QAAQ,EAAE,IAAI,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACjE,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED,2EAA2E;IAC3E,IAAI,gBAAgB,IAAI,QAAQ,EAAE,CAAC;QACjC,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,mBAAmB,EAAE,CAAC;QAC5D,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IACrE,CAAC;IACD,MAAM,QAAQ,GAA6B;QACzC,eAAe;QACf,KAAK;QACL,aAAa,EAAE,IAAI,CAAC,gBAAgB,EAAE;QACtC,SAAS,EAAE,eAAe;KAC3B,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACzC,CAAC"}