fix(useTriggerChat): make AI SDK dependencies optional peer dependencies

Author: jakevollkommer

packages/react-hooks/package.json

@@ -37,11 +37,7 @@
     "check-exports": "attw --pack ."
   },
   "dependencies": {
-    "@ai-sdk/react": "^2.0.14",
-    "@electric-sql/client": "1.0.14",
     "@trigger.dev/core": "workspace:^4.0.5",
-    "ai": "^5.0.82",
-    "eventsource-parser": "^3.0.0",
     "swr": "^2.2.5"
   },
   "devDependencies": {
@@ -54,7 +50,25 @@
   },
   "peerDependencies": {
     "react": "^18.0 || ^19.0 || ^19.0.0-rc",
-    "react-dom": "^18.0 || ^19.0 || ^19.0.0-rc"
+    "react-dom": "^18.0 || ^19.0 || ^19.0.0-rc",
+    "@ai-sdk/react": "^2.0.0",
+    "@electric-sql/client": "^1.0.0",
+    "ai": "^5.0.0",
+    "eventsource-parser": "^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@ai-sdk/react": {
+      "optional": true
+    },
+    "@electric-sql/client": {
+      "optional": true
+    },
+    "ai": {
+      "optional": true
+    },
+    "eventsource-parser": {
+      "optional": true
+    }
   },
   "engines": {
     "node": ">=18.20.0"

packages/react-hooks/src/hooks/useTriggerChat.ts

@@ -4,25 +4,14 @@ import { ShapeStream } from "@electric-sql/client";
 import { EventSourceParserStream } from "eventsource-parser/stream";
 
 import { useChat, type UseChatHelpers } from "@ai-sdk/react";
-import type {
-  UIMessage,
-  UIMessageChunk,
-  ChatRequestOptions,
-  ChatInit,
-} from "ai";
-import type {
-  AnyTask,
-  TaskIdentifier,
-  AnyRealtimeRun,
-} from "@trigger.dev/core/v3";
+import type { UIMessage, UIMessageChunk, ChatRequestOptions, ChatInit } from "ai";
+import type { AnyTask, TaskIdentifier, AnyRealtimeRun } from "@trigger.dev/core/v3";
 
 const DEFAULT_TASK = "chat";
 const DEFAULT_STREAM_KEY = "chat";
 const DEFAULT_BASE_URL = "https://api.trigger.dev";
 
-export interface TriggerChatTaskPayload<
-  UI_MESSAGE extends UIMessage = UIMessage,
-> {
+export interface TriggerChatTaskPayload<UI_MESSAGE extends UIMessage = UIMessage> {
   chatId?: string;
   messageId?: string;
   messages: UI_MESSAGE[];
@@ -92,7 +81,7 @@ export interface TriggerChatTransportOptions<
    */
   triggerTask: (
     task: TaskIdentifier<AnyTask>,
-    payload: TriggerChatTaskPayload,
+    payload: TriggerChatTaskPayload
   ) => Promise<{
     success: boolean;
     runId?: string;
@@ -159,9 +148,7 @@ type ParsedMetadata = {
  */
 export class TriggerChatTransport {
   private readonly task: TaskIdentifier<AnyTask>;
-  private readonly triggerTask: NonNullable<
-    TriggerChatTransportOptions["triggerTask"]
-  >;
+  private readonly triggerTask: NonNullable<TriggerChatTransportOptions["triggerTask"]>;
   private readonly accessToken?: string | (() => string | Promise<string>);
   private readonly streamKey: string;
   private readonly baseURL: string;
@@ -183,7 +170,7 @@ export class TriggerChatTransport {
     options: {
       abortSignal: AbortSignal | undefined;
     } & ChatRequestOptions &
-      TriggerChatTaskPayload,
+      TriggerChatTaskPayload
   ): Promise<ReadableStream<UIMessageChunk>> {
     const { abortSignal, ...payloadOptions } = options;
 
@@ -209,7 +196,7 @@ export class TriggerChatTransport {
   }
 
   async reconnectToStream(
-    options: { chatId: string } & ChatRequestOptions,
+    options: { chatId: string } & ChatRequestOptions
   ): Promise<ReadableStream<UIMessageChunk> | null> {
     const runId = this.activeRuns.get(options.chatId);
 
@@ -235,7 +222,7 @@ export class TriggerChatTransport {
 
   private async subscribeToRun(
     runId: string,
-    abortSignal: AbortSignal | undefined,
+    abortSignal: AbortSignal | undefined
   ): Promise<ReadableStream<UIMessageChunk>> {
     const accessToken = await this.resolveAccessToken(runId);
     const streamKey = this.streamKey;
@@ -307,7 +294,7 @@ export class TriggerChatTransport {
               if (abortSignal) {
                 abortSignal.removeEventListener("abort", handleAbort);
               }
-            },
+            }
           );
         } catch (error) {
           cleanup();
@@ -325,7 +312,7 @@ export class TriggerChatTransport {
 
     if (!this.accessToken) {
       throw new Error(
-        "No access token available. Provide accessToken option or ensure tasks.trigger() returns publicAccessToken",
+        "No access token available. Provide accessToken option or ensure tasks.trigger() returns publicAccessToken"
       );
     }
 
@@ -342,7 +329,7 @@ export class TriggerChatTransport {
  * Handles both string (JSON) and object formats
  */
 function parseMetadata(
-  metadata: Record<string, unknown> | string | undefined,
+  metadata: Record<string, unknown> | string | undefined
 ): ParsedMetadata | undefined {
   if (!metadata) return undefined;
 
@@ -387,9 +374,7 @@ function subscribeToDataStreams(params: {
   } = params;
 
   if (!metadata?.$$streams || !Array.isArray(metadata.$$streams)) {
-    console.warn(
-      "Unable to subscribe to streams: metadata.$$streams does not contain an array",
-    );
+    console.warn("Unable to subscribe to streams: metadata.$$streams does not contain an array");
     return;
   }
 
@@ -422,14 +407,7 @@ async function streamDataFromTrigger(params: {
   runAbortController: AbortController;
   controller: ReadableStreamDefaultController<UIMessageChunk>;
 }) {
-  const {
-    streamKey,
-    runId,
-    baseURL,
-    accessToken,
-    runAbortController,
-    controller,
-  } = params;
+  const { streamKey, runId, baseURL, accessToken, runAbortController, controller } = params;
 
   try {
     const streamUrl = `${baseURL}/realtime/v1/streams/${runId}/${streamKey}`;
@@ -479,8 +457,7 @@ async function streamDataFromTrigger(params: {
       reader.releaseLock();
     }
   } catch (error) {
-    const shouldIgnoreError =
-      error instanceof Error && error.name === "AbortError";
+    const shouldIgnoreError = error instanceof Error && error.name === "AbortError";
 
     if (!shouldIgnoreError) {
       throw error;
@@ -572,9 +549,46 @@ type UseTriggerChatOptions = {
  * }
  * ```
  */
-export function useTriggerChat(
-  options: UseTriggerChatOptions,
-): UseChatHelpers<UIMessage> {
+export function useTriggerChat(options: UseTriggerChatOptions): UseChatHelpers<UIMessage> {
+  // Check for required peer dependencies at runtime
+  try {
+    require.resolve("@ai-sdk/react");
+    require.resolve("ai");
+    require.resolve("@electric-sql/client");
+    require.resolve("eventsource-parser");
+  } catch (e) {
+    const missing: string[] = [];
+    try {
+      require.resolve("@ai-sdk/react");
+    } catch {
+      missing.push("@ai-sdk/react");
+    }
+    try {
+      require.resolve("ai");
+    } catch {
+      missing.push("ai");
+    }
+    try {
+      require.resolve("@electric-sql/client");
+    } catch {
+      missing.push("@electric-sql/client");
+    }
+    try {
+      require.resolve("eventsource-parser");
+    } catch {
+      missing.push("eventsource-parser");
+    }
+
+    throw new Error(
+      `useTriggerChat requires the following packages:\n${missing
+        .map((pkg) => `  - ${pkg}`)
+        .join("\n")}\n\n` +
+        `Install them with:\n  npm install ${missing.join(" ")}\n  or\n  pnpm add ${missing.join(
+          " "
+        )}`
+    );
+  }
+
   const { transportOptions, ...chatOptions } = options;
 
   return useChat({