Export explicit send/reconnect option helper types

Co-authored-by: Eric Allam <eric@trigger.dev>

Author: cursoragent

packages/ai/README.md

@@ -7,6 +7,7 @@ AI SDK integrations for Trigger.dev.
 - `TriggerChatTransport` for wiring AI SDK `useChat()` to Trigger.dev tasks + Realtime Streams v2
 - `createTriggerChatTransport(...)` factory helper
 - `ai.tool(...)` and `ai.currentToolOptions()` helpers for tool-calling flows
+- helper types such as `TriggerChatSendMessagesOptions`, `TriggerChatReconnectOptions`, and `TriggerChatHeadersInput`
 
 ## Install
 

packages/ai/src/chatTransport.ts

@@ -8,13 +8,15 @@ import {
   TriggerOptions,
 } from "@trigger.dev/core/v3";
 import type {
-  ChatRequestOptions,
   ChatTransport,
   InferUIMessageChunk,
   UIMessage,
   UIMessageChunk,
 } from "ai";
 import type {
+  TriggerChatHeadersInput,
+  TriggerChatReconnectOptions,
+  TriggerChatSendMessagesOptions,
   TriggerChatOnTriggeredRun,
   TriggerChatPayloadMapper,
   TriggerChatRunState,
@@ -62,12 +64,6 @@ type TriggerTaskRequestBody = {
   options?: TriggerTaskRequestOptions;
 };
 
-type TriggerChatRequestOptionsWithTupleHeaders = Omit<ChatRequestOptions, "headers"> & {
-  headers?:
-    | ChatRequestOptions["headers"]
-    | Array<[string, string]>;
-};
-
 type TriggerChatTransportCommonOptions<
   UI_MESSAGE extends UIMessage = UIMessage,
 > = {
@@ -158,13 +154,7 @@ export class TriggerChatTransport<
   }
 
   public async sendMessages(
-    options: {
-      trigger: "submit-message" | "regenerate-message";
-      chatId: string;
-      messageId: string | undefined;
-      messages: UI_MESSAGE[];
-      abortSignal: AbortSignal | undefined;
-    } & TriggerChatRequestOptionsWithTupleHeaders
+    options: TriggerChatSendMessagesOptions<UI_MESSAGE>
   ): Promise<ReadableStream<UIMessageChunk>> {
     const transportRequest = createTransportRequest<UI_MESSAGE>(options);
     const payload = await this.payloadMapper(transportRequest);
@@ -199,9 +189,7 @@ export class TriggerChatTransport<
   }
 
   public async reconnectToStream(
-    options: {
-      chatId: string;
-    } & ChatRequestOptions
+    options: TriggerChatReconnectOptions
   ): Promise<ReadableStream<UIMessageChunk> | null> {
     const runState = await this.runStore.get(options.chatId);
 
@@ -342,13 +330,7 @@ function resolvePayloadMapper<
 }
 
 function createTransportRequest<UI_MESSAGE extends UIMessage>(
-  options: {
-    trigger: "submit-message" | "regenerate-message";
-    chatId: string;
-    messageId: string | undefined;
-    messages: UI_MESSAGE[];
-    abortSignal: AbortSignal | undefined;
-  } & TriggerChatRequestOptionsWithTupleHeaders
+  options: TriggerChatSendMessagesOptions<UI_MESSAGE>
 ): TriggerChatTransportRequest<UI_MESSAGE> {
   return {
     chatId: options.chatId,
@@ -395,11 +377,7 @@ function resolveStreamKey<UI_MESSAGE extends UIMessage>(
 }
 
 function normalizeHeaders(
-  headers:
-    | Record<string, string>
-    | Headers
-    | Array<[string, string]>
-    | undefined
+  headers: TriggerChatHeadersInput | undefined
 ): Record<string, string> | undefined {
   if (!headers) {
     return undefined;

packages/ai/src/chatTransport.types.test.ts

@@ -4,6 +4,9 @@ import {
   createTriggerChatTransport,
   TriggerChatTransport,
   TriggerChatTransportOptions,
+  type TriggerChatHeadersInput,
+  type TriggerChatReconnectOptions,
+  type TriggerChatSendMessagesOptions,
   type TriggerChatTransportPayload,
   type TriggerChatTransportRequest,
   type TriggerChatRunState,
@@ -129,8 +132,25 @@ it("accepts tuple-style headers in sendMessages options", function () {
     accessToken: "pk_test",
   });
 
+  const headersInput: TriggerChatHeadersInput = [["x-header", "x-value"]];
+
+  const sendOptions: TriggerChatSendMessagesOptions<UIMessage> = {
+    trigger: "submit-message",
+    chatId: "chat_123",
+    messageId: undefined,
+    messages: [],
+    abortSignal: undefined,
+    headers: headersInput,
+  };
+
+  const reconnectOptions: TriggerChatReconnectOptions = {
+    chatId: "chat_123",
+    headers: headersInput,
+  };
+
   type SendMessagesParams = Parameters<typeof transport.sendMessages>[0];
-  const tupleHeaders: SendMessagesParams["headers"] = [["x-header", "x-value"]];
+  const tupleHeaders: SendMessagesParams["headers"] = sendOptions.headers;
+  expectTypeOf(reconnectOptions).toBeObject();
   expectTypeOf(transport.sendMessages).toBeFunction();
   void tupleHeaders;
 });

packages/ai/src/index.ts

@@ -6,10 +6,13 @@ export {
   type TriggerChatTransportOptions,
 } from "./chatTransport.js";
 export type {
+  TriggerChatHeadersInput,
   TriggerChatPayloadMapper,
   TriggerChatOnTriggeredRun,
+  TriggerChatReconnectOptions,
   TriggerChatRunState,
   TriggerChatRunStore,
+  TriggerChatSendMessagesOptions,
   TriggerChatStream,
   TriggerChatTaskContext,
   TriggerChatTransportPayload,

packages/ai/src/types.ts

@@ -12,6 +12,11 @@ export type TriggerChatTransportTrigger =
   | "submit-message"
   | "regenerate-message";
 
+export type TriggerChatHeadersInput =
+  | Record<string, string>
+  | Headers
+  | Array<[string, string]>;
+
 export type TriggerChatTransportRequest<
   UI_MESSAGE extends UIMessage = UIMessage,
 > = {
@@ -85,3 +90,21 @@ export interface TriggerChatRunStore {
   set(state: TriggerChatRunState): Promise<void> | void;
   delete(chatId: string): Promise<void> | void;
 }
+
+export type TriggerChatSendMessagesOptions<
+  UI_MESSAGE extends UIMessage = UIMessage,
+> = {
+  trigger: TriggerChatTransportTrigger;
+  chatId: string;
+  messageId: string | undefined;
+  messages: UI_MESSAGE[];
+  abortSignal: AbortSignal | undefined;
+} & Omit<ChatRequestOptions, "headers"> & {
+    headers?: TriggerChatHeadersInput;
+  };
+
+export type TriggerChatReconnectOptions = {
+  chatId: string;
+} & Omit<ChatRequestOptions, "headers"> & {
+    headers?: TriggerChatHeadersInput;
+  };