@anthropic-ai/sdk 0.61.0 → 0.63.0

package/src/lib/tools/ToolRunner.ts

@@ -0,0 +1,374 @@
+import { BetaRunnableTool } from './BetaRunnableTool';
+import { Anthropic } from '../..';
+import { AnthropicError } from '../../core/error';
+import { BetaMessage, BetaMessageParam, BetaToolUnion, MessageCreateParams } from '../../resources/beta';
+import { BetaMessageStream } from '../BetaMessageStream';
+
+/**
+ * Just Promise.withResolvers(), which is not available in all environments.
+ */
+function promiseWithResolvers<T>(): {
+  promise: Promise<T>;
+  resolve: (value: T) => void;
+  reject: (reason?: any) => void;
+} {
+  let resolve: (value: T) => void;
+  let reject: (reason?: any) => void;
+  const promise = new Promise<T>((res, rej) => {
+    resolve = res;
+    reject = rej;
+  });
+  return { promise, resolve: resolve!, reject: reject! };
+}
+
+/**
+ * A ToolRunner handles the automatic conversation loop between the assistant and tools.
+ *
+ * A ToolRunner is an async iterable that yields either BetaMessage or BetaMessageStream objects
+ * depending on the streaming configuration.
+ */
+export class BetaToolRunner<Stream extends boolean> {
+  /** Whether the async iterator has been consumed */
+  #consumed = false;
+  /** Whether parameters have been mutated since the last API call */
+  #mutated = false;
+  /** Current state containing the request parameters */
+  #state: { params: BetaToolRunnerParams };
+  /** Promise for the last message received from the assistant */
+  #message?: Promise<BetaMessage> | undefined;
+  /** Cached tool response to avoid redundant executions */
+  #toolResponse?: Promise<BetaMessageParam | null> | undefined;
+  /** Promise resolvers for waiting on completion */
+  #completion: {
+    promise: Promise<BetaMessage>;
+    resolve: (value: BetaMessage) => void;
+    reject: (reason?: any) => void;
+  };
+  /** Number of iterations (API requests) made so far */
+  #iterationCount = 0;
+
+  constructor(
+    private client: Anthropic,
+    params: BetaToolRunnerParams,
+  ) {
+    this.#state = {
+      params: {
+        // You can't clone the entire params since there are functions as handlers.
+        // You also don't really need to clone params.messages, but it probably will prevent a foot gun
+        // somewhere.
+        ...params,
+        messages: structuredClone(params.messages),
+      },
+    };
+
+    this.#completion = promiseWithResolvers();
+  }
+
+  async *[Symbol.asyncIterator](): AsyncIterator<
+    Stream extends true ? BetaMessageStream
+    : Stream extends false ? BetaMessage
+    : BetaMessage | BetaMessageStream
+  > {
+    if (this.#consumed) {
+      throw new AnthropicError('Cannot iterate over a consumed stream');
+    }
+
+    this.#consumed = true;
+    this.#mutated = true;
+    this.#toolResponse = undefined;
+
+    try {
+      while (true) {
+        let stream;
+        try {
+          if (
+            this.#state.params.max_iterations &&
+            this.#iterationCount >= this.#state.params.max_iterations
+          ) {
+            break;
+          }
+
+          this.#mutated = false;
+          this.#message = undefined;
+          this.#toolResponse = undefined;
+          this.#iterationCount++;
+
+          const { max_iterations, ...params } = this.#state.params;
+          if (params.stream) {
+            stream = this.client.beta.messages.stream({ ...params });
+            this.#message = stream.finalMessage();
+            yield stream as any;
+          } else {
+            this.#message = this.client.beta.messages.create({ ...params, stream: false });
+            yield this.#message as any;
+          }
+
+          if (!this.#mutated) {
+            const { role, content } = await this.#message;
+            this.#state.params.messages.push({ role, content });
+          }
+
+          const toolMessage = await this.#generateToolResponse(this.#state.params.messages.at(-1)!);
+          if (toolMessage) {
+            this.#state.params.messages.push(toolMessage);
+          }
+
+          if (!toolMessage && !this.#mutated) {
+            break;
+          }
+        } finally {
+          if (stream) {
+            stream.abort();
+          }
+        }
+      }
+
+      if (!this.#message) {
+        throw new AnthropicError('ToolRunner concluded without a message from the server');
+      }
+
+      this.#completion.resolve(await this.#message);
+    } catch (error) {
+      this.#consumed = false;
+      // Silence unhandled promise errors
+      this.#completion.promise.catch(() => {});
+      this.#completion.reject(error);
+      this.#completion = promiseWithResolvers();
+      throw error;
+    }
+  }
+
+  /**
+   * Update the parameters for the next API call. This invalidates any cached tool responses.
+   *
+   * @param paramsOrMutator - Either new parameters or a function to mutate existing parameters
+   *
+   * @example
+   * // Direct parameter update
+   * runner.setMessagesParams({
+   *   model: 'claude-3-5-haiku-latest',
+   *   max_tokens: 500,
+   * });
+   *
+   * @example
+   * // Using a mutator function
+   * runner.setMessagesParams((params) => ({
+   *   ...params,
+   *   max_tokens: 100,
+   * }));
+   */
+  setMessagesParams(params: BetaToolRunnerParams): void;
+  setMessagesParams(mutator: (prevParams: BetaToolRunnerParams) => BetaToolRunnerParams): void;
+  setMessagesParams(
+    paramsOrMutator: BetaToolRunnerParams | ((prevParams: BetaToolRunnerParams) => BetaToolRunnerParams),
+  ) {
+    if (typeof paramsOrMutator === 'function') {
+      this.#state.params = paramsOrMutator(this.#state.params);
+    } else {
+      this.#state.params = paramsOrMutator;
+    }
+    this.#mutated = true;
+    // Invalidate cached tool response since parameters changed
+    this.#toolResponse = undefined;
+  }
+
+  /**
+   * Get the tool response for the last message from the assistant.
+   * Avoids redundant tool executions by caching results.
+   *
+   * @returns A promise that resolves to a BetaMessageParam containing tool results, or null if no tools need to be executed
+   *
+   * @example
+   * const toolResponse = await runner.generateToolResponse();
+   * if (toolResponse) {
+   *   console.log('Tool results:', toolResponse.content);
+   * }
+   */
+  async generateToolResponse() {
+    const message = (await this.#message) ?? this.params.messages.at(-1);
+    if (!message) {
+      return null;
+    }
+    return this.#generateToolResponse(message);
+  }
+
+  async #generateToolResponse(lastMessage: BetaMessageParam) {
+    if (this.#toolResponse !== undefined) {
+      return this.#toolResponse;
+    }
+    this.#toolResponse = generateToolResponse(this.#state.params, lastMessage);
+    return this.#toolResponse;
+  }
+
+  /**
+   * Wait for the async iterator to complete. This works even if the async iterator hasn't yet started, and
+   * will wait for an instance to start and go to completion.
+   *
+   * @returns A promise that resolves to the final BetaMessage when the iterator completes
+   *
+   * @example
+   * // Start consuming the iterator
+   * for await (const message of runner) {
+   *   console.log('Message:', message.content);
+   * }
+   *
+   * // Meanwhile, wait for completion from another part of the code
+   * const finalMessage = await runner.done();
+   * console.log('Final response:', finalMessage.content);
+   */
+  done(): Promise<BetaMessage> {
+    return this.#completion.promise;
+  }
+
+  /**
+   * Returns a promise indicating that the stream is done. Unlike .done(), this will eagerly read the stream:
+   * * If the iterator has not been consumed, consume the entire iterator and return the final message from the
+   * assistant.
+   * * If the iterator has been consumed, waits for it to complete and returns the final message.
+   *
+   * @returns A promise that resolves to the final BetaMessage from the conversation
+   * @throws {AnthropicError} If no messages were processed during the conversation
+   *
+   * @example
+   * const finalMessage = await runner.runUntilDone();
+   * console.log('Final response:', finalMessage.content);
+   */
+  async runUntilDone(): Promise<BetaMessage> {
+    // If not yet consumed, start consuming and wait for completion
+    if (!this.#consumed) {
+      for await (const _ of this) {
+        // Iterator naturally populates this.#message
+      }
+    }
+
+    // If consumed but not completed, wait for completion
+    return this.done();
+  }
+
+  /**
+   * Get the current parameters being used by the ToolRunner.
+   *
+   * @returns A readonly view of the current ToolRunnerParams
+   *
+   * @example
+   * const currentParams = runner.params;
+   * console.log('Current model:', currentParams.model);
+   * console.log('Message count:', currentParams.messages.length);
+   */
+  get params(): Readonly<BetaToolRunnerParams> {
+    return this.#state.params as Readonly<BetaToolRunnerParams>;
+  }
+
+  /**
+   * Add one or more messages to the conversation history.
+   *
+   * @param messages - One or more BetaMessageParam objects to add to the conversation
+   *
+   * @example
+   * runner.pushMessages(
+   *   { role: 'user', content: 'Also, what about the weather in NYC?' }
+   * );
+   *
+   * @example
+   * // Adding multiple messages
+   * runner.pushMessages(
+   *   { role: 'user', content: 'What about NYC?' },
+   *   { role: 'user', content: 'And Boston?' }
+   * );
+   */
+  pushMessages(...messages: BetaMessageParam[]) {
+    this.setMessagesParams((params) => ({
+      ...params,
+      messages: [...params.messages, ...messages],
+    }));
+  }
+
+  /**
+   * Makes the ToolRunner directly awaitable, equivalent to calling .runUntilDone()
+   * This allows using `await runner` instead of `await runner.runUntilDone()`
+   */
+  then<TResult1 = BetaMessage, TResult2 = never>(
+    onfulfilled?: ((value: BetaMessage) => TResult1 | PromiseLike<TResult1>) | undefined | null,
+    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null,
+  ): Promise<TResult1 | TResult2> {
+    return this.runUntilDone().then(onfulfilled, onrejected);
+  }
+}
+
+async function generateToolResponse(
+  params: BetaToolRunnerParams,
+  lastMessage = params.messages.at(-1),
+): Promise<BetaMessageParam | null> {
+  // Only process if the last message is from the assistant and has tool use blocks
+  if (
+    !lastMessage ||
+    lastMessage.role !== 'assistant' ||
+    !lastMessage.content ||
+    typeof lastMessage.content === 'string'
+  ) {
+    return null;
+  }
+
+  const toolUseBlocks = lastMessage.content.filter((content) => content.type === 'tool_use');
+  if (toolUseBlocks.length === 0) {
+    return null;
+  }
+
+  const toolResults = await Promise.all(
+    toolUseBlocks.map(async (toolUse) => {
+      const tool = params.tools.find((t) => t.name === toolUse.name);
+      if (!tool || !('run' in tool)) {
+        return {
+          type: 'tool_result' as const,
+          tool_use_id: toolUse.id,
+          content: `Error: Tool '${toolUse.name}' not found`,
+          is_error: true,
+        };
+      }
+
+      try {
+        let input = toolUse.input;
+        if ('parse' in tool && tool.parse) {
+          input = tool.parse(input);
+        }
+
+        const result = await tool.run(input);
+        return {
+          type: 'tool_result' as const,
+          tool_use_id: toolUse.id,
+          content: result,
+        };
+      } catch (error) {
+        return {
+          type: 'tool_result' as const,
+          tool_use_id: toolUse.id,
+          content: `Error: ${error instanceof Error ? error.message : String(error)}`,
+          is_error: true,
+        };
+      }
+    }),
+  );
+
+  return {
+    role: 'user' as const,
+    content: toolResults,
+  };
+}
+
+// vendored from typefest just to make things look a bit nicer on hover
+type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
+
+/**
+ * Parameters for creating a ToolRunner, extending MessageCreateParams with runnable tools.
+ */
+export type BetaToolRunnerParams = Simplify<
+  Omit<MessageCreateParams, 'tools'> & {
+    tools: (BetaToolUnion | BetaRunnableTool<any>)[];
+    /**
+     * Maximum number of iterations (API requests) to make in the tool execution loop.
+     * Each iteration consists of: assistant response → tool execution → tool results.
+     * When exceeded, the loop will terminate even if tools are still being requested.
+     */
+    max_iterations?: number;
+  }
+>;

package/src/resources/beta/beta.ts

@@ -32,6 +32,7 @@ import {
   BetaCacheCreation,
   BetaCitationCharLocation,
   BetaCitationCharLocationParam,
+  BetaCitationConfig,
   BetaCitationContentBlockLocation,
   BetaCitationContentBlockLocationParam,
   BetaCitationPageLocation,
@@ -62,6 +63,7 @@ import {
   BetaContentBlockParam,
   BetaContentBlockSource,
   BetaContentBlockSourceContent,
+  BetaDocumentBlock,
   BetaFileDocumentSource,
   BetaFileImageSource,
   BetaImageBlockParam,
@@ -127,6 +129,7 @@ import {
   BetaToolComputerUse20241022,
   BetaToolComputerUse20250124,
   BetaToolResultBlockParam,
+  BetaToolResultContentBlockParam,
   BetaToolTextEditor20241022,
   BetaToolTextEditor20250124,
   BetaToolTextEditor20250429,
@@ -137,6 +140,14 @@ import {
   BetaURLImageSource,
   BetaURLPDFSource,
   BetaUsage,
+  BetaWebFetchBlock,
+  BetaWebFetchBlockParam,
+  BetaWebFetchTool20250910,
+  BetaWebFetchToolResultBlock,
+  BetaWebFetchToolResultBlockParam,
+  BetaWebFetchToolResultErrorBlock,
+  BetaWebFetchToolResultErrorBlockParam,
+  BetaWebFetchToolResultErrorCode,
   BetaWebSearchResultBlock,
   BetaWebSearchResultBlockParam,
   BetaWebSearchTool20250305,
@@ -295,6 +306,7 @@ export declare namespace Beta {
     type BetaCacheCreation as BetaCacheCreation,
     type BetaCitationCharLocation as BetaCitationCharLocation,
     type BetaCitationCharLocationParam as BetaCitationCharLocationParam,
+    type BetaCitationConfig as BetaCitationConfig,
     type BetaCitationContentBlockLocation as BetaCitationContentBlockLocation,
     type BetaCitationContentBlockLocationParam as BetaCitationContentBlockLocationParam,
     type BetaCitationPageLocation as BetaCitationPageLocation,
@@ -325,6 +337,7 @@ export declare namespace Beta {
     type BetaContentBlockParam as BetaContentBlockParam,
     type BetaContentBlockSource as BetaContentBlockSource,
     type BetaContentBlockSourceContent as BetaContentBlockSourceContent,
+    type BetaDocumentBlock as BetaDocumentBlock,
     type BetaFileDocumentSource as BetaFileDocumentSource,
     type BetaFileImageSource as BetaFileImageSource,
     type BetaImageBlockParam as BetaImageBlockParam,
@@ -390,6 +403,7 @@ export declare namespace Beta {
     type BetaToolComputerUse20241022 as BetaToolComputerUse20241022,
     type BetaToolComputerUse20250124 as BetaToolComputerUse20250124,
     type BetaToolResultBlockParam as BetaToolResultBlockParam,
+    type BetaToolResultContentBlockParam as BetaToolResultContentBlockParam,
     type BetaToolTextEditor20241022 as BetaToolTextEditor20241022,
     type BetaToolTextEditor20250124 as BetaToolTextEditor20250124,
     type BetaToolTextEditor20250429 as BetaToolTextEditor20250429,
@@ -400,6 +414,14 @@ export declare namespace Beta {
     type BetaURLImageSource as BetaURLImageSource,
     type BetaURLPDFSource as BetaURLPDFSource,
     type BetaUsage as BetaUsage,
+    type BetaWebFetchBlock as BetaWebFetchBlock,
+    type BetaWebFetchBlockParam as BetaWebFetchBlockParam,
+    type BetaWebFetchTool20250910 as BetaWebFetchTool20250910,
+    type BetaWebFetchToolResultBlock as BetaWebFetchToolResultBlock,
+    type BetaWebFetchToolResultBlockParam as BetaWebFetchToolResultBlockParam,
+    type BetaWebFetchToolResultErrorBlock as BetaWebFetchToolResultErrorBlock,
+    type BetaWebFetchToolResultErrorBlockParam as BetaWebFetchToolResultErrorBlockParam,
+    type BetaWebFetchToolResultErrorCode as BetaWebFetchToolResultErrorCode,
     type BetaWebSearchResultBlock as BetaWebSearchResultBlock,
     type BetaWebSearchResultBlockParam as BetaWebSearchResultBlockParam,
     type BetaWebSearchTool20250305 as BetaWebSearchTool20250305,

package/src/resources/beta/index.ts

@@ -42,6 +42,7 @@ export {
   type BetaCacheCreation,
   type BetaCitationCharLocation,
   type BetaCitationCharLocationParam,
+  type BetaCitationConfig,
   type BetaCitationContentBlockLocation,
   type BetaCitationContentBlockLocationParam,
   type BetaCitationPageLocation,
@@ -72,6 +73,7 @@ export {
   type BetaContentBlockParam,
   type BetaContentBlockSource,
   type BetaContentBlockSourceContent,
+  type BetaDocumentBlock,
   type BetaFileDocumentSource,
   type BetaFileImageSource,
   type BetaImageBlockParam,
@@ -137,6 +139,7 @@ export {
   type BetaToolComputerUse20241022,
   type BetaToolComputerUse20250124,
   type BetaToolResultBlockParam,
+  type BetaToolResultContentBlockParam,
   type BetaToolTextEditor20241022,
   type BetaToolTextEditor20250124,
   type BetaToolTextEditor20250429,
@@ -147,6 +150,14 @@ export {
   type BetaURLImageSource,
   type BetaURLPDFSource,
   type BetaUsage,
+  type BetaWebFetchBlock,
+  type BetaWebFetchBlockParam,
+  type BetaWebFetchTool20250910,
+  type BetaWebFetchToolResultBlock,
+  type BetaWebFetchToolResultBlockParam,
+  type BetaWebFetchToolResultErrorBlock,
+  type BetaWebFetchToolResultErrorBlockParam,
+  type BetaWebFetchToolResultErrorCode,
   type BetaWebSearchResultBlock,
   type BetaWebSearchResultBlockParam,
   type BetaWebSearchTool20250305,

package/src/resources/beta/messages/index.ts

@@ -35,6 +35,7 @@ export {
   type BetaCacheCreation,
   type BetaCitationCharLocation,
   type BetaCitationCharLocationParam,
+  type BetaCitationConfig,
   type BetaCitationContentBlockLocation,
   type BetaCitationContentBlockLocationParam,
   type BetaCitationPageLocation,
@@ -65,6 +66,7 @@ export {
   type BetaContentBlockParam,
   type BetaContentBlockSource,
   type BetaContentBlockSourceContent,
+  type BetaDocumentBlock,
   type BetaFileDocumentSource,
   type BetaFileImageSource,
   type BetaImageBlockParam,
@@ -130,6 +132,7 @@ export {
   type BetaToolComputerUse20241022,
   type BetaToolComputerUse20250124,
   type BetaToolResultBlockParam,
+  type BetaToolResultContentBlockParam,
   type BetaToolTextEditor20241022,
   type BetaToolTextEditor20250124,
   type BetaToolTextEditor20250429,
@@ -140,6 +143,14 @@ export {
   type BetaURLImageSource,
   type BetaURLPDFSource,
   type BetaUsage,
+  type BetaWebFetchBlock,
+  type BetaWebFetchBlockParam,
+  type BetaWebFetchTool20250910,
+  type BetaWebFetchToolResultBlock,
+  type BetaWebFetchToolResultBlockParam,
+  type BetaWebFetchToolResultErrorBlock,
+  type BetaWebFetchToolResultErrorBlockParam,
+  type BetaWebFetchToolResultErrorCode,
   type BetaWebSearchResultBlock,
   type BetaWebSearchResultBlockParam,
   type BetaWebSearchTool20250305,
@@ -157,3 +168,4 @@ export {
   type MessageCountTokensParams,
   type BetaMessageStreamParams,
 } from './messages';
+export { BetaToolRunner, type BetaToolRunnerParams } from './messages';