@assistant-ui/react-langchain 0.0.6 → 0.0.8

package/src/useStreamRuntime.ts

@@ -5,6 +5,7 @@ import type {
   AppendMessage,
   AttachmentAdapter,
   FeedbackAdapter,
+  RemoteThreadListAdapter,
   SpeechSynthesisAdapter,
 } from "@assistant-ui/core";
 import {
@@ -18,8 +19,8 @@ import {
 import { useAui, useAuiState } from "@assistant-ui/store";
 import type { AssistantCloud } from "assistant-cloud";
 import { useStream, type UseStreamOptions } from "@langchain/react";
-import type { LangChainBaseMessage } from "./types";
-import { convertLangChainBaseMessage } from "./convertMessages";
+import type { LangChainBaseMessage, LangChainToolCall } from "./types";
+import { convertLangChainBaseMessage, getMessageType } from "./convertMessages";
 
 const symbolLangChainRuntimeExtras = Symbol("langchain-runtime-extras");
 
@@ -32,6 +33,7 @@ type LangChainRuntimeExtras = {
     options?: Record<string, unknown>,
   ) => Promise<void>;
   values: Record<string, unknown>;
+  messagesKey: string;
 };
 
 const asLangChainRuntimeExtras = (extras: unknown): LangChainRuntimeExtras => {
@@ -46,7 +48,7 @@ const asLangChainRuntimeExtras = (extras: unknown): LangChainRuntimeExtras => {
   return extras as LangChainRuntimeExtras;
 };
 
-export type UseStreamRuntimeOptions = UseStreamOptions & {
+type LangChainRuntimeExtraOptions = {
   cloud?: AssistantCloud | undefined;
   adapters?:
     | {
@@ -55,10 +57,54 @@ export type UseStreamRuntimeOptions = UseStreamOptions & {
         feedback?: FeedbackAdapter | undefined;
       }
     | undefined;
-  /** The key in the LangGraph state that contains messages. Defaults to "messages". */
-  messagesKey?: string | undefined;
+  /**
+   * When the user sends a new message while previous tool calls are
+   * still pending, automatically submit `tool` messages that cancel
+   * them so the agent's tool-call accounting stays consistent.
+   * Defaults to `true`.
+   */
+  autoCancelPendingToolCalls?: boolean | undefined;
+  /**
+   * Routes the Cancel button's click to `useStream().stop()`. On by
+   * default. Pass `false` to disable the Cancel button.
+   */
+  unstable_allowCancellation?: boolean | undefined;
+  /**
+   * Custom `RemoteThreadListAdapter`. When provided, replaces the
+   * cloud-backed thread list adapter.
+   */
+  unstable_threadListAdapter?: RemoteThreadListAdapter | undefined;
+  /** Custom thread-creation hook, forwarded to the cloud adapter. */
+  create?: (() => Promise<{ externalId: string | undefined }>) | undefined;
+  /** Custom thread-deletion hook, forwarded to the cloud adapter. */
+  delete?: ((threadId: string) => Promise<void>) | undefined;
 };
 
+const getPendingToolCalls = (
+  messages: readonly LangChainBaseMessage[],
+): LangChainToolCall[] => {
+  const pending = new Map<string, LangChainToolCall>();
+  for (const m of messages) {
+    const type = getMessageType(m);
+    if (type === "ai") {
+      for (const tc of m.tool_calls ?? []) pending.set(tc.id, tc);
+    } else if (type === "tool" && m.tool_call_id) {
+      pending.delete(m.tool_call_id);
+    }
+  }
+  return [...pending.values()];
+};
+
+// Distribute the intersection through the union arms of `UseStreamOptions`
+// (`AgentServerOptions | CustomAdapterOptions`). Writing `UseStreamOptions & X`
+// directly collapses arm tracking, so `Omit<…, "cloud">` and the like would
+// produce a flattened structural type that no longer matches either arm.
+export type UseStreamRuntimeOptions = UseStreamOptions extends infer O
+  ? O extends UseStreamOptions
+    ? O & LangChainRuntimeExtraOptions
+    : never
+  : never;
+
 const getMessageContent = (msg: AppendMessage) => {
   const allContent = [
     ...msg.content,
@@ -91,8 +137,12 @@ const getMessageContent = (msg: AppendMessage) => {
       case "tool-call":
         throw new Error("Tool call appends are not supported.");
       default: {
-        const _exhaustiveCheck: "reasoning" | "source" | "audio" | "data" =
-          type;
+        const _exhaustiveCheck:
+          | "reasoning"
+          | "source"
+          | "audio"
+          | "data"
+          | "generative-ui" = type;
         throw new Error(
           `Unsupported append message part type: ${_exhaustiveCheck}`,
         );
@@ -106,21 +156,31 @@ const getMessageContent = (msg: AppendMessage) => {
   return content;
 };
 
-const useStreamThreadRuntime = ({
-  adapters,
-  messagesKey = "messages",
-  ...streamOptions
-}: Omit<UseStreamRuntimeOptions, "cloud">) => {
+type DistributiveOmit<T, K extends keyof any> = T extends unknown
+  ? Omit<T, K>
+  : never;
+
+const useStreamThreadRuntime = (
+  options: DistributiveOmit<
+    UseStreamRuntimeOptions,
+    "cloud" | "unstable_threadListAdapter" | "create" | "delete"
+  >,
+) => {
+  const { adapters, autoCancelPendingToolCalls, unstable_allowCancellation } =
+    options;
+  const messagesKey = options.messagesKey ?? "messages";
+
   // biome-ignore lint/correctness/useHookAtTopLevel: intentional conditional/nested hook usage
   const externalId = useAuiState((s) => s.threadListItem.externalId) as
     | string
     | null;
+  // Mutate in place rather than `{ ...options, threadId }`: spreading
+  // `UseStreamOptions` (a discriminated union on `transport`) into an object
+  // literal merges both arms' transport types, breaking arm assignment.
+  options.threadId = externalId;
 
   // biome-ignore lint/correctness/useHookAtTopLevel: intentional conditional/nested hook usage
-  const stream = useStream({
-    ...streamOptions,
-    threadId: externalId,
-  });
+  const stream = useStream(options);
 
   // biome-ignore lint/correctness/useHookAtTopLevel: intentional conditional/nested hook usage
   const [toolStatuses, setToolStatuses] = useState<
@@ -185,8 +245,15 @@ const useStreamThreadRuntime = ({
       interrupts: stream.interrupts,
       submit: stream.submit,
       values: stream.values,
+      messagesKey,
     }),
-    [stream.interrupt, stream.interrupts, stream.submit, stream.values],
+    [
+      stream.interrupt,
+      stream.interrupts,
+      stream.submit,
+      stream.values,
+      messagesKey,
+    ],
   );
 
   // biome-ignore lint/correctness/useHookAtTopLevel: intentional conditional/nested hook usage
@@ -198,8 +265,20 @@ const useStreamThreadRuntime = ({
     onNew: async (msg) => {
       await toolInvocations.abort();
       const content = getMessageContent(msg);
+      const cancellations =
+        autoCancelPendingToolCalls !== false
+          ? getPendingToolCalls(
+              streamRef.current.messages as readonly LangChainBaseMessage[],
+            ).map((t) => ({
+              type: "tool" as const,
+              name: t.name,
+              tool_call_id: t.id,
+              content: JSON.stringify({ cancelled: true }),
+              status: "error" as const,
+            }))
+          : [];
       await stream.submit({
-        [messagesKey]: [{ type: "human", content }],
+        [messagesKey]: [...cancellations, { type: "human", content }],
       });
     },
     onAddToolResult: async ({
@@ -222,10 +301,13 @@ const useStreamThreadRuntime = ({
         ],
       });
     },
-    onCancel: async () => {
-      await stream.stop();
-      await toolInvocations.abort();
-    },
+    onCancel:
+      unstable_allowCancellation !== false
+        ? async () => {
+            await stream.stop();
+            await toolInvocations.abort();
+          }
+        : undefined,
   });
 
   return runtime;
@@ -255,20 +337,31 @@ const useStreamThreadRuntime = ({
  * }
  * ```
  */
-export const useStreamRuntime = ({
-  cloud,
-  ...options
-}: UseStreamRuntimeOptions) => {
+export const useStreamRuntime = (rawOptions: UseStreamRuntimeOptions) => {
+  const {
+    cloud,
+    unstable_threadListAdapter,
+    create,
+    delete: deleteFn,
+    ...options
+  } = rawOptions;
+
   const optionsRef = useRef(options);
   optionsRef.current = options;
 
-  const cloudAdapter = useCloudThreadListAdapter({ cloud });
+  const cloudAdapter = useCloudThreadListAdapter({
+    cloud,
+    create,
+    delete: deleteFn,
+  });
+  const adapter = unstable_threadListAdapter ?? cloudAdapter;
+
   return useRemoteThreadListRuntime({
     runtimeHook: function RuntimeHook() {
       // biome-ignore lint/correctness/useHookAtTopLevel: intentional conditional/nested hook usage
       return useStreamThreadRuntime(optionsRef.current);
     },
-    adapter: cloudAdapter,
+    adapter,
     allowNesting: true,
   });
 };
@@ -301,6 +394,36 @@ export const useLangChainSubmit = () => {
   };
 };
 
+/**
+ * Submit a list of LangChain-shaped messages on the current thread.
+ * Parity helper for migrating from `useLangGraphSend`. Routes to
+ * `useStream().submit({ [messagesKey]: messages }, options)`.
+ */
+export const useLangChainSend = () => {
+  const aui = useAui();
+  return (
+    messages: readonly LangChainBaseMessage[],
+    options?: Record<string, unknown>,
+  ) => {
+    const { submit, messagesKey } = asLangChainRuntimeExtras(
+      aui.thread().getState().extras,
+    );
+    return submit({ [messagesKey]: messages }, options);
+  };
+};
+
+/**
+ * Submit a `useStream` command (e.g. interrupt resume). Parity helper
+ * for migrating from `useLangGraphSendCommand`. Note that v1's command
+ * shape (`{ resume?, goto?, update? }`) differs from the legacy
+ * `{ resume: string }` form — to carry a payload, use the input or
+ * `stream.respond` instead.
+ */
+export const useLangChainSendCommand = () => {
+  const submit = useLangChainSubmit();
+  return (command: Record<string, unknown>) => submit(null, { command });
+};
+
 /**
  * Read a custom LangGraph state key from the current thread. Mirrors
  * `useStream().values[key]` from `@langchain/react` and updates when the

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,0BAA0B,EAC1B,iBAAiB,EACjB,kBAAkB,GACnB,8BAA2B;AAC5B,YAAY,EAAE,uBAAuB,EAAE,8BAA2B;AAElE,OAAO,EAAE,2BAA2B,EAAE,6BAA0B;AAEhE,YAAY,EACV,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,GAClB,mBAAgB"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,0BAA0B,EAC1B,iBAAiB,EACjB,kBAAkB,GACnB,8BAA2B;AAG5B,OAAO,EAAE,2BAA2B,EAAE,6BAA0B"}

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}