@trigger.dev/sdk 0.0.0-prerelease-20260908122921 → 0.0.0-prerelease-streamfix-20260909094302

package/dist/esm/v3/ai.d.ts

@@ -1,5 +1,5 @@
-import { type AnyTask, type Task, type ApiClientConfiguration, type inferSchemaIn, type inferSchemaOut, type MachinePresetName, type RealtimeDefinedInputStream, type RealtimeDefinedStream, type TaskIdentifier, type TaskOptions, type TaskRunContext, type TaskSchema, type TaskWithSchema, type AnySessionChannel, type SessionChannelName } from "@trigger.dev/core/v3";
-import type { streamText as aiStreamTextSignature, FinishReason, LanguageModelUsage, ModelMessage, SystemModelMessage, ProviderMetadata, Tool, ToolSet, UIMessage, UIMessageChunk, UIMessageStreamOptions } from "ai";
+import { type AnyTask, type Task, type ChatSnapshotV1, type ApiClientConfiguration, type inferSchemaIn, type inferSchemaOut, type MachinePresetName, type RealtimeDefinedInputStream, type RealtimeDefinedStream, type SessionTriggerConfig, type TaskIdentifier, type TaskOptions, type TaskRunContext, type TaskSchema, type TaskWithSchema, type AnySessionChannel, type SessionChannelName } from "@trigger.dev/core/v3";
+import type { FinishReason, LanguageModelUsage, ModelMessage, ProviderMetadata, Tool, ToolSet, UIMessage, UIMessageChunk, UIMessageStreamOptions } from "ai";
 import { type ChatInputChunk, type ChatTaskWirePayload, type InferChatClientData, type InferChatUIMessage, type InferChatUIMessageFromTools, PENDING_MESSAGE_INJECTED_TYPE, upsertIncomingMessage } from "./ai-shared.js";
 import { locals } from "./locals.js";
 import type { ResolvedPrompt } from "./prompt.js";
@@ -11,8 +11,7 @@ type ToolCallOptions = {
     experimental_context?: unknown;
     context?: unknown;
 };
-import { type ChatVersionSkewPolicy } from "./chatVersionSkew.js";
-import { type SessionChannelHandleFor, type SessionTriggerConfigInput } from "./sessions.js";
+import { type SessionChannelHandleFor } from "./sessions.js";
 /** Re-export for typing `ctx` in `chat.agent` hooks without importing `@trigger.dev/core`. */
 export type { TaskRunContext } from "@trigger.dev/core/v3";
 export type ToolCallExecutionOptions = {
@@ -202,7 +201,7 @@ export type ChatTaskPayload<TClientData = unknown> = {
      *   to short-circuit the LLM call when an action doesn't need a response.
      * - `"close"`: The chat session is being closed (internal; `run()` is not called).
      */
-    trigger: "submit-message" | "regenerate-message" | "preload" | "action" | "action-turn" | "close";
+    trigger: "submit-message" | "regenerate-message" | "preload" | "action" | "close";
     /** The ID of the message to regenerate (only for `"regenerate-message"`) */
     messageId?: string;
     /** Custom data from the frontend (passed via `metadata` on `sendMessage()` or the transport). */
@@ -243,16 +242,6 @@ export type ChatTaskRunPayload<TClientData = unknown, TTools extends ToolSet = T
      * Use for tags, metadata, parent run links, or any API that needs the full run record.
      */
     ctx: TaskRunContext;
-    /**
-     * `streamText` with this agent's managed options already applied: the
-     * prompt from `chat.prompt.set()`, the skill tools, telemetry, and the
-     * `prepareStep` that delivers steering, compaction and injected context.
-     *
-     * Prefer it over importing `streamText` from `ai`. The imported one takes
-     * none of that unless you spread `chat.toStreamTextOptions()` yourself, and
-     * forgetting the spread fails silently.
-     */
-    streamText: AiStreamTextFn;
     /** Token usage from the previous turn. Undefined on turn 0. */
     previousTurnUsage?: LanguageModelUsage;
     /** Cumulative token usage across all completed turns so far. */
@@ -849,12 +838,6 @@ export declare function buildSkillTools(skills: ResolvedSkill[]): Record<string,
  * Options for {@link toStreamTextOptions}.
  */
 export type ToStreamTextOptionsOptions = {
-    /**
-     * A base system prompt, used when `chat.prompt.set()` has not supplied one.
-     * `chat.agent({ system })` and a `system` passed to the managed `streamText`
-     * both arrive here.
-     */
-    system?: string | SystemModelMessage;
     /** Additional telemetry metadata merged into `experimental_telemetry.metadata`. */
     telemetry?: Record<string, string>;
     /**
@@ -925,23 +908,6 @@ export type SystemCacheControl = {
  *
  * If no prompt has been set, returns `{}` (no-op spread).
  */
-/**
- * The AI SDK's own `streamText` signature, borrowed rather than restated.
- *
- * The peer range spans `ai` v5, v6 and v7, whose `streamText` options differ.
- * Describing the shape here would drift against all three; `typeof` resolves to
- * whichever version the user installed, so generics, overloads and tool
- * inference are exactly theirs.
- */
-type AiStreamTextFn = typeof aiStreamTextSignature;
-/**
- * The `streamText` handed to a `chat.agent` `run()`, carrying the agent's
- * managed options.
- *
- * Exported so a loop factored out of `run` can take it as a parameter and keep
- * them: `function loop(messages: ModelMessage[], streamText: ChatStreamText)`.
- */
-export type ChatStreamText = AiStreamTextFn;
 declare function toStreamTextOptions(options?: ToStreamTextOptionsOptions): Record<string, unknown>;
 /**
  * Options for `pipeChat`.
@@ -987,37 +953,6 @@ export type ChatUIMessageStreamOptions<TUIM extends UIMessage = UIMessage> = Omi
 type UIMessageStreamable = {
     toUIMessageStream: (...args: any[]) => AsyncIterable<unknown> | ReadableStream<unknown>;
 };
-declare const actionTurnBrand: unique symbol;
-/**
- * The marker `onAction` returns to have a turn run on the history it just
- * edited. Produce it with {@link chat.turn}.
- */
-export type ActionTurn = {
-    readonly [actionTurnBrand]: true;
-};
-/**
- * Turn the current action into a turn.
- *
- * Return it from `onAction` after editing history. The action's own work is
- * finished first (the edit is applied and snapshotted), then a turn runs on the
- * result exactly as a message turn does: `onTurnStart`, `run()` with the edited
- * history, `onBeforeTurnComplete`, `onTurnComplete`, and the turn counter
- * advances. That gives the answer everything a turn has, the system prompt,
- * tools, steering, compaction, injected instructions and persistence, with no
- * action-specific handling.
- *
- * @example
- * ```ts
- * onAction: async ({ action }) => {
- *   if (action.type === "regenerate") {
- *     chat.history.slice(0, -1);
- *     return chat.turn();
- *   }
- *   if (action.type === "undo") chat.history.slice(0, -2); // no turn
- * },
- * ```
- */
-declare function chatTurn(): ActionTurn;
 /**
  * Pipes a chat stream to the realtime stream, making it available to the
  * `TriggerChatTransport` on the frontend.
@@ -1610,17 +1545,6 @@ export type ChatAgentOptions<TIdentifier extends string, TClientDataSchema exten
      * ```
      */
     oomMachine?: MachinePresetName;
-    /**
-     * What to do when the session's `externalDeploymentId` no longer names the deployment
-     * this run is on — after a redeploy re-pins the session, say.
-     *
-     * - `"follow"` (default) hands the conversation to the pinned deployment at the next
-     *   turn boundary, so no `chat.requestUpgrade()` of your own is needed.
-     * - `"hold"` stays put until you ask to move. Manual `chat.requestUpgrade()` works either way.
-     *
-     * Ignored for sessions with no pin, and for sessions using `lockToVersion`.
-     */
-    versionSkew?: ChatVersionSkewPolicy;
     /**
      * Schema for validating `clientData` from the frontend.
      * Accepts Zod, ArkType, Valibot, or any supported schema library.
@@ -1675,14 +1599,13 @@ export type ChatAgentOptions<TIdentifier extends string, TClientDataSchema exten
      * `onBeforeTurnComplete` / `onTurnComplete`, no `run()`. Use
      * `chat.history.*` inside `onAction` to mutate state.
      *
-     * To answer after the edit, return `chat.turn()`: the edit is applied and
-     * snapshotted, then a turn runs on the result with every turn guarantee. An
-     * action that returns nothing is a state edit only. Returning anything else
-     * is an error; a response can no longer be returned directly.
+     * To produce a model response from an action, return a
+     * `StreamTextResult` (auto-piped), `string`, or `UIMessage`. Returning
+     * `void` or nothing is the side-effect-only default.
      */
     onAction?: (event: ActionEvent<[
         TActionSchema
-    ] extends [TaskSchema] ? inferSchemaOut<TActionSchema> : unknown, inferSchemaOut<TClientDataSchema>, TUIMessage>) => Promise<void | ActionTurn> | void | ActionTurn;
+    ] extends [TaskSchema] ? inferSchemaOut<TActionSchema> : unknown, inferSchemaOut<TClientDataSchema>, TUIMessage>) => Promise<unknown> | unknown;
     /**
      * The tools available to this agent.
      *
@@ -1974,31 +1897,6 @@ export type ChatAgentOptions<TIdentifier extends string, TClientDataSchema exten
      * });
      * ```
      */
-    /**
-     * A provider registry, so the runtime can resolve the managed prompt's model
-     * for the `streamText` it hands to `run()`. Only needed when you set a model
-     * through `chat.prompt.set()` and want the bound `streamText` to honour it.
-     */
-    registry?: ToStreamTextOptionsOptions["registry"];
-    /**
-     * The agent's system prompt. Injected instructions append to it, and the
-     * `streamText` handed to `run()` carries it without a spread.
-     *
-     * Set it here, at the call site, or through `chat.prompt.set()` for versioned
-     * config, but only in one of them.
-     */
-    system?: ToStreamTextOptionsOptions["system"];
-    /**
-     * Mark the system prompt for provider-side caching, the same sugar
-     * `chat.toStreamTextOptions({ cacheControl })` takes. See
-     * [prompt caching](/ai-chat/prompt-caching).
-     */
-    cacheControl?: ToStreamTextOptionsOptions["cacheControl"];
-    /**
-     * Provider options for the system block, when `cacheControl` is not enough.
-     * Takes precedence over `cacheControl`.
-     */
-    systemProviderOptions?: ToStreamTextOptionsOptions["systemProviderOptions"];
     compaction?: ChatAgentCompactionOptions<TUIMessage>;
     /**
      * Configure how messages that arrive during streaming are handled.
@@ -2492,22 +2390,15 @@ declare function setUIMessageStreamOptions(options: ChatUIMessageStreamOptions<U
  */
 declare function isStopped(): boolean;
 /**
- * Hand the conversation over to another deployment.
- *
- * The handover happens immediately and server-side: a successor run is created
- * and picks the conversation up from `session.in`. The transport keeps reading
- * the same session output, so no client action is needed and nothing waits for
- * the next message.
- *
- * Without a target the session's pin is cleared, so the successor lands on the
- * latest deployed version; with `externalDeploymentId` the session is re-pinned
- * to that deployment.
+ * Request that the current run exits so the next message starts on the latest
+ * deployed version (via the standard continuation mechanism).
  *
  * When called from `onTurnStart` or `onValidateMessages`, `run()` is skipped
- * entirely and the successor answers the message that opened the turn.
+ * entirely — the run exits immediately and the transport re-triggers the
+ * same message on the new version.
  *
  * When called from `run()` or `chat.defer()`, the current turn completes
- * normally and the handover happens afterward.
+ * normally and the run exits afterward instead of waiting for the next message.
  *
  * Call from `onTurnStart`, `onValidateMessages`, `onChatResume`, `run()`,
  * or inside `chat.defer()`.
@@ -2527,9 +2418,7 @@ declare function isStopped(): boolean;
  * });
  * ```
  */
-declare function requestUpgrade(options?: {
-    externalDeploymentId?: string;
-}): void;
+declare function requestUpgrade(): void;
 /**
  * Hand off the current custom agent Session to a fresh run.
  *
@@ -2588,50 +2477,6 @@ declare function endAndContinue(): Promise<void>;
  * ```
  */
 declare function endRun(): void;
-/**
- * End the whole conversation, permanently. The session row is closed, further
- * appends are refused, and the run exits without scheduling a continuation.
- *
- * This is the session-level stop. {@link endRun} ends the current run and lets
- * the next message start a fresh one; `chat.close()` ends the session itself,
- * so there is no next message. Use it for a budget cap, a completed goal,
- * abuse detection, or a user signing out.
- *
- * In a `chat.agent`, call it from `run()`, `prepareStep`, or
- * `onBeforeTurnComplete`. Called mid-step, it aborts the in-flight
- * `streamText` the same way the stop signal does, so the partial response is
- * still captured and streamed. The turn then completes normally, a terminal
- * `session-closed` record carrying `reason` is written to the response stream,
- * and the loop exits.
- *
- * Prefer `onBeforeTurnComplete` over `onTurnComplete`. It carries the same
- * fields but still runs while the stream is open, so the closed state rides
- * out on the turn's final record. `onTurnComplete` runs after that record, so
- * a close decided there does not reach a reader that has already finished the
- * turn, and the user only finds out when their next message is refused.
- *
- * In a `chat.customAgent`, call it anywhere in your own loop. The close is
- * performed when `run()` returns, so it lands whether you break out of a
- * `chat.createSession` loop, return early, or hand-roll the loop entirely.
- *
- * Closing is one-way: a closed session cannot be reopened. Its transcript
- * stays readable.
- *
- * @example
- * ```ts
- * chat.agent({
- *   id: "budgeted-agent",
- *   onBeforeTurnComplete: async ({ usage }) => {
- *     if (await overBudget(usage)) {
- *       chat.close({ reason: "Monthly budget reached" });
- *     }
- *   },
- * });
- * ```
- */
-declare function close(options?: {
-    reason?: string;
-}): void;
 /**
  * Register a promise that runs in the background during the current turn.
  *
@@ -2901,20 +2746,6 @@ declare class ChatMessageAccumulator {
      * Queue a message for injection, converting to model messages automatically.
      */
     steerAsync(message: UIMessage): Promise<void>;
-    /**
-     * Record the messages a steering drain consumed.
-     *
-     * The drain only puts them in this step's prompt, so without this they
-     * shape one answer and then exist in neither lane: not in `uiMessages`,
-     * which is what an app persists from, and not in `modelMessages`, which is
-     * what every later turn sends.
-     *
-     * Both lanes are appended to. The model lane is never reconverted from the
-     * UI lane, because `compactIfNeeded` replaces it with a summary and leaves
-     * the UI lane whole: a reconversion would restore everything the summary
-     * replaced.
-     */
-    absorbSteering(claimed: UIMessage[], injected?: ModelMessage[]): Promise<void>;
     /**
      * Get and clear unconsumed steering messages.
      */
@@ -2952,11 +2783,6 @@ export type ChatSessionOptions = {
     timeout?: string;
     /** Max turns before ending. @default 100 */
     maxTurns?: number;
-    /**
-     * What to do when the session's `externalDeploymentId` no longer names this deployment.
-     * `"follow"` (default) hands over at the next turn boundary; `"hold"` stays put.
-     */
-    versionSkew?: ChatVersionSkewPolicy;
     /** Automatic context compaction — same options as `chat.agent({ compaction })`. */
     compaction?: ChatAgentCompactionOptions;
     /** Configure mid-execution message injection — same options as `chat.agent({ pendingMessages })`. */
@@ -3168,7 +2994,7 @@ export type CreateChatStartSessionActionOptions = {
      * Default trigger config used when starting a new session for a chat.
      * Per-call `params.triggerConfig` shallow-merges on top.
      */
-    triggerConfig?: Partial<SessionTriggerConfigInput>;
+    triggerConfig?: Partial<SessionTriggerConfig>;
     /**
      * Override the Trigger.dev API base URL. String applies to both
      * `/api/v1/sessions` and `/api/v1/auth/jwt/claims`; function picks per
@@ -3211,7 +3037,7 @@ export type ChatStartSessionParams<TChat extends AnyTask = AnyTask> = {
      * `chat.agent`: anything beyond `chatId`/`messages`/`trigger`/`metadata`,
      * which the runtime injects automatically).
      */
-    triggerConfig?: Partial<SessionTriggerConfigInput>;
+    triggerConfig?: Partial<SessionTriggerConfig>;
     /**
      * Opaque session-level metadata stored on the Session row. Separate from
      * the per-turn `clientData` above. Use this when you want to attach
@@ -3233,11 +3059,6 @@ export type ChatStartSessionResult = {
     runId: string;
     /** Session friendlyId — informational. */
     sessionId: string;
-    /**
-     * The session's run is parked waiting for its deployment. Messages sent meanwhile are durable
-     * and delivered once it lands; surface this so the wait reads as a deploy in progress.
-     */
-    pendingVersion?: boolean;
 };
 /**
  * Creates a server-side helper that starts (or resumes) a Session for a
@@ -3287,8 +3108,6 @@ export declare const chat: {
     createStartSessionAction: typeof createChatStartSessionAction;
     /** Pipe a stream to the chat transport. See {@link pipeChat}. */
     pipe: typeof pipeChat;
-    /** Return from `onAction` to run a turn on the edited history. See {@link chatTurn}. */
-    turn: typeof chatTurn;
     /** Create a per-run typed local. See {@link chatLocal}. */
     local: typeof chatLocal;
     /** Create a public access token for a chat task. See {@link createChatAccessToken}. */
@@ -3309,8 +3128,6 @@ export declare const chat: {
     endAndContinue: typeof endAndContinue;
     /** Exit the run after the current turn completes, without any upgrade signal. See {@link endRun}. */
     endRun: typeof endRun;
-    /** End the conversation permanently: close the session and exit the run. See {@link close}. */
-    close: typeof close;
     /** Clean up aborted parts from a UIMessage. See {@link cleanupAbortedParts}. */
     cleanupAbortedParts: typeof cleanupAbortedParts;
     /** Register background work that runs in parallel with streaming. See {@link chatDefer}. */