@ai-sdk/provider-utils 5.0.0-canary.43 → 5.0.0-canary.45

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @ai-sdk/provider-utils
 
+## 5.0.0-canary.45
+
+### Patch Changes
+
+- ee798eb: chore(provider-utils): rename `Experimental_Sandbox` to `Experimental_SandboxSession`
+- daf6637: feat(provider-utils): add `env` option to `spawn` and `run` methods of `Experimental_SandboxSession`
+
+## 5.0.0-canary.44
+
+### Patch Changes
+
+- 6c93e36: feat(provider-utils): add `spawnCommand` method to `Experimental_Sandbox` to allow for detached command execution
+- f617ac2: feat(provider-utils): narrow `tool()` return type to `ExecutableTool<...>` when `execute` is provided
+
 ## 5.0.0-canary.43
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1171,6 +1171,17 @@ declare const postToApi: <T>({ url, headers, body, successfulResponseHandler, fa
  */
 type Context = Record<string, unknown>;
 
+/**
+ * A tool that is guaranteed to expose an execute function.
+ */
+type ExecutableTool<TOOL extends Tool = Tool> = TOOL & {
+    execute: NonNullable<TOOL['execute']>;
+};
+/**
+ * Checks whether a tool exposes an execute function.
+ */
+declare function isExecutableTool<TOOL extends Tool>(tool: TOOL | undefined): tool is ExecutableTool<TOOL>;
+
 type NeverOptional<N, T> = 0 extends 1 & N ? Partial<T> : [N] extends [never] ? Partial<Record<keyof T, undefined>> : T;
 
 /**
@@ -1298,45 +1309,71 @@ type UserContent = string | Array<TextPart | ImagePart | FilePart>;
 type ModelMessage = SystemModelMessage | UserModelMessage | AssistantModelMessage | ToolModelMessage;
 
 /**
- * Sandbox environment that can execute commands and read/write files.
+ * Options for executing a command in the sandbox via `run` or `spawn`.
+ */
+type SandboxProcessOptions = {
+    /**
+     * Command to execute in the sandbox.
+     */
+    command: string;
+    /**
+     * Working directory to execute the command in.
+     */
+    workingDirectory?: string;
+    /**
+     * Environment variables to set for this command. Merged with the
+     * sandbox's default environment; values here take precedence.
+     * Supporting environment variables as an option is preferable from a
+     * security perspective, e.g. to avoid them leaking in logs.
+     */
+    env?: Record<string, string>;
+    /**
+     * Signal that can be used to abort the command. When aborted, the running
+     * process is killed; for `spawn`, `wait()` rejects with the abort reason.
+     */
+    abortSignal?: AbortSignal;
+};
+/**
+ * Options for reading a file from the sandbox.
+ */
+type ReadFileOptions = {
+    /**
+     * Path of the file to read.
+     */
+    path: string;
+    /**
+     * Signal that can be used to abort the read.
+     */
+    abortSignal?: AbortSignal;
+};
+/**
+ * Options for writing a file to the sandbox. `CONTENT` is the payload written
+ * to the file: a byte stream, raw bytes, or a string.
+ */
+type WriteFileOptions<CONTENT> = {
+    /**
+     * Path of the file to write.
+     */
+    path: string;
+    /**
+     * Content to write to the file.
+     */
+    content: CONTENT;
+    /**
+     * Signal that can be used to abort the write.
+     */
+    abortSignal?: AbortSignal;
+};
+/**
+ * Sandbox session that can execute commands and read/write files.
  */
-type Experimental_Sandbox = {
+type SandboxSession = {
     /**
      * Description of the sandbox environment that can be added to the agent's instructions
      * so that the agent knows about relevant details such as the root directory, exposed
      * ports, the public hostname, etc.
      */
     readonly description: string;
-    /**
-     * Run a command in the sandbox.
-     */
-    readonly runCommand: (options: {
-        /**
-         * Command to execute in the sandbox.
-         */
-        command: string;
-        /**
-         * Working directory to execute the command in.
-         */
-        workingDirectory?: string;
-        /**
-         * Signal that can be used to abort the command.
-         */
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<{
-        /**
-         * Exit code returned by the command.
-         */
-        exitCode: number;
-        /**
-         * Standard output produced by the command.
-         */
-        stdout: string;
-        /**
-         * Standard error produced by the command.
-         */
-        stderr: string;
-    }>;
     /**
      * Read one file from the sandbox as a stream of bytes. Resolves to `null`
      * when the file does not exist.
@@ -1345,30 +1382,12 @@ type Experimental_Sandbox = {
      * read primitive; prefer `readBinaryFile` or `readTextFile` unless you need
      * to stream bytes.
      */
-    readonly readFile: (options: {
-        /**
-         * Path of the file to read.
-         */
-        path: string;
-        /**
-         * Signal that can be used to abort the read.
-         */
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<ReadableStream<Uint8Array> | null>;
+    readonly readFile: (options: ReadFileOptions) => PromiseLike<ReadableStream<Uint8Array> | null>;
     /**
      * Read one file from the sandbox as raw bytes. Resolves to `null` when the
      * file does not exist.
      */
-    readonly readBinaryFile: (options: {
-        /**
-         * Path of the file to read.
-         */
-        path: string;
-        /**
-         * Signal that can be used to abort the read.
-         */
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<Uint8Array | null>;
+    readonly readBinaryFile: (options: ReadFileOptions) => PromiseLike<Uint8Array | null>;
     /**
      * Read one text file from the sandbox, decoded using the requested encoding.
      * Resolves to `null` when the file does not exist.
@@ -1376,11 +1395,7 @@ type Experimental_Sandbox = {
      * Line ranges are 1-based and inclusive. When `endLine` is past EOF the read
      * returns through EOF without error.
      */
-    readonly readTextFile: (options: {
-        /**
-         * Path of the file to read.
-         */
-        path: string;
+    readonly readTextFile: (options: ReadFileOptions & {
         /**
          * Text encoding used to decode the file bytes. Defaults to `"utf-8"`.
          */
@@ -1394,10 +1409,6 @@ type Experimental_Sandbox = {
          * returns through EOF without error.
          */
         endLine?: number;
-        /**
-         * Signal that can be used to abort the read.
-         */
-        abortSignal?: AbortSignal;
     }) => PromiseLike<string | null>;
     /**
      * Write one file to the sandbox from a stream of bytes. Creates parent
@@ -1406,61 +1417,75 @@ type Experimental_Sandbox = {
      * This is the lowest-level write primitive; prefer `writeBinaryFile` or
      * `writeTextFile` when the full content is already materialized in memory.
      */
-    readonly writeFile: (options: {
-        /**
-         * Path of the file to write.
-         */
-        path: string;
-        /**
-         * Stream of bytes to write.
-         */
-        content: ReadableStream<Uint8Array>;
-        /**
-         * Signal that can be used to abort the write.
-         */
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<void>;
+    readonly writeFile: (options: WriteFileOptions<ReadableStream<Uint8Array>>) => PromiseLike<void>;
     /**
      * Write one file to the sandbox from raw bytes. Creates parent directories
      * recursively and overwrites any existing file.
      */
-    readonly writeBinaryFile: (options: {
-        /**
-         * Path of the file to write.
-         */
-        path: string;
-        /**
-         * Raw bytes to write.
-         */
-        content: Uint8Array;
-        /**
-         * Signal that can be used to abort the write.
-         */
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<void>;
+    readonly writeBinaryFile: (options: WriteFileOptions<Uint8Array>) => PromiseLike<void>;
     /**
      * Write one file to the sandbox from a string, encoded using the requested
      * encoding. Creates parent directories recursively and overwrites any
      * existing file.
      */
-    readonly writeTextFile: (options: {
+    readonly writeTextFile: (options: WriteFileOptions<string> & {
         /**
-         * Path of the file to write.
+         * Text encoding used to encode the string to bytes. Defaults to `"utf-8"`.
          */
-        path: string;
+        encoding?: string;
+    }) => PromiseLike<void>;
+    /**
+     * Spawn a long-running process in the sandbox. Returns immediately with a
+     * handle that streams stdout/stderr, can be waited on, and can be killed.
+     *
+     * `run` is conceptually a thin wrapper over this primitive: spawn,
+     * collect both streams to strings, await `wait()`, return the result.
+     */
+    readonly spawn: (options: SandboxProcessOptions) => PromiseLike<SandboxProcess>;
+    /**
+     * Run a command in the sandbox.
+     */
+    readonly run: (options: SandboxProcessOptions) => PromiseLike<{
         /**
-         * Text content to write.
+         * Exit code returned by the command.
          */
-        content: string;
+        exitCode: number;
         /**
-         * Text encoding used to encode the string to bytes. Defaults to `"utf-8"`.
+         * Standard output produced by the command.
          */
-        encoding?: string;
+        stdout: string;
         /**
-         * Signal that can be used to abort the write.
+         * Standard error produced by the command.
          */
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<void>;
+        stderr: string;
+    }>;
+};
+/**
+ * Handle to a long-running process started via `SandboxSession.spawn`.
+ */
+type SandboxProcess = {
+    /**
+     * Process identifier, if the sandbox implementation exposes one.
+     */
+    readonly pid?: number;
+    /**
+     * Stream of bytes written by the process to standard output.
+     */
+    readonly stdout: ReadableStream<Uint8Array>;
+    /**
+     * Stream of bytes written by the process to standard error.
+     */
+    readonly stderr: ReadableStream<Uint8Array>;
+    /**
+     * Resolve when the process exits, yielding its exit code.
+     */
+    wait(): PromiseLike<{
+        exitCode: number;
+    }>;
+    /**
+     * Terminate the process. Idempotent.
+     */
+    kill(): PromiseLike<void>;
 };
 
 /**
@@ -1495,7 +1520,7 @@ interface ToolExecutionOptions<CONTEXT extends Context | unknown | never> {
     /**
      * The sandbox environment that the tool is operating in.
      */
-    experimental_sandbox?: Experimental_Sandbox;
+    experimental_sandbox?: SandboxSession;
 }
 /**
  * Function that executes the tool and returns either a single result or a stream of results.
@@ -1663,7 +1688,7 @@ type BaseFunctionTool<INPUT extends JSONValue | unknown | never = any, OUTPUT ex
      */
     description?: string | ((options: {
         context: NoInfer<CONTEXT>;
-        experimental_sandbox?: Experimental_Sandbox;
+        experimental_sandbox?: SandboxSession;
     }) => string);
     /**
      * Strict mode setting for the tool.
@@ -1768,7 +1793,14 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
  * Infer the tool type from a tool object.
  *
  * This is useful for type inference when working with tool objects.
+ *
+ * When the input has an `execute` function, the return type narrows to
+ * `ExecutableTool<Tool<...>>` so that `.execute` is non-nullable without
+ * needing `isExecutableTool` or a `!` assertion at the call site.
  */
+declare function tool<INPUT, OUTPUT, CONTEXT extends Context>(tool: Tool<INPUT, OUTPUT, CONTEXT> & {
+    execute: ToolExecuteFunction<INPUT, OUTPUT, CONTEXT>;
+}): ExecutableTool<Tool<INPUT, OUTPUT, CONTEXT>>;
 declare function tool<INPUT, OUTPUT, CONTEXT extends Context>(tool: Tool<INPUT, OUTPUT, CONTEXT>): Tool<INPUT, OUTPUT, CONTEXT>;
 declare function tool<INPUT, CONTEXT extends Context>(tool: Tool<INPUT, never, CONTEXT>): Tool<INPUT, never, CONTEXT>;
 declare function tool<OUTPUT, CONTEXT extends Context>(tool: Tool<never, OUTPUT, CONTEXT>): Tool<never, OUTPUT, CONTEXT>;
@@ -2099,17 +2131,6 @@ declare function withUserAgentSuffix(headers: HeadersInit | Record<string, strin
 
 declare function withoutTrailingSlash(url: string | undefined): string | undefined;
 
-/**
- * A tool that is guaranteed to expose an execute function.
- */
-type ExecutableTool<TOOL extends Tool = Tool> = TOOL & {
-    execute: NonNullable<TOOL['execute']>;
-};
-/**
- * Checks whether a tool exposes an execute function.
- */
-declare function isExecutableTool<TOOL extends Tool>(tool: TOOL | undefined): tool is ExecutableTool<TOOL>;
-
 /**
  * Detects the `any` type so untyped tools can be treated as having no explicit
  * context type.
@@ -2261,4 +2282,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
     dynamic?: boolean;
 }
 
-export { type Arrayable, type AssistantContent, type AssistantModelMessage, type Context, type CustomPart, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type DynamicTool, type ExecutableTool, type Experimental_Sandbox, type FetchFunction, type FileData, type FileDataData, type FileDataReference, type FileDataText, type FileDataUrl, type FilePart, type FlexibleSchema, type FunctionTool, type HasRequiredKey, type IdGenerator, type ImagePart, type InferSchema, type InferToolContext, type InferToolInput, type InferToolOutput, type InferToolSetContext, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderDefinedTool, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderExecutedTool, type ProviderExecutedToolFactory, type ProviderOptions, type ProviderReference, type ReasoningFilePart, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type StreamingToolCallDelta, StreamingToolCallTracker, type StreamingToolCallTrackerOptions, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type ToolSet, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asArray, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertInlineFileDataToUint8Array, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createProviderExecutedToolFactory, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, detectMediaType, downloadBlob, dynamicTool, executeTool, extractLines, extractResponseHeaders, filterNullable, generateId, getFromApi, getRuntimeEnvironmentUserAgent, getTopLevelMediaType, injectJsonInstructionIntoMessages, isAbortError, isBuffer, isCustomReasoning, isExecutableTool, isFullMediaType, isNonNullable, isParsableJson, isProviderReference, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mapReasoningToProviderBudget, mapReasoningToProviderEffort, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, resolveFullMediaType, resolveProviderReference, safeParseJSON, safeValidateTypes, serializeModelOptions, stripFileExtension, tool, validateDownloadUrl, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type Arrayable, type AssistantContent, type AssistantModelMessage, type Context, type CustomPart, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type DynamicTool, type ExecutableTool, type SandboxProcess as Experimental_SandboxProcess, type SandboxSession as Experimental_SandboxSession, type FetchFunction, type FileData, type FileDataData, type FileDataReference, type FileDataText, type FileDataUrl, type FilePart, type FlexibleSchema, type FunctionTool, type HasRequiredKey, type IdGenerator, type ImagePart, type InferSchema, type InferToolContext, type InferToolInput, type InferToolOutput, type InferToolSetContext, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderDefinedTool, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderExecutedTool, type ProviderExecutedToolFactory, type ProviderOptions, type ProviderReference, type ReasoningFilePart, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type StreamingToolCallDelta, StreamingToolCallTracker, type StreamingToolCallTrackerOptions, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type ToolSet, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asArray, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertInlineFileDataToUint8Array, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createProviderExecutedToolFactory, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, detectMediaType, downloadBlob, dynamicTool, executeTool, extractLines, extractResponseHeaders, filterNullable, generateId, getFromApi, getRuntimeEnvironmentUserAgent, getTopLevelMediaType, injectJsonInstructionIntoMessages, isAbortError, isBuffer, isCustomReasoning, isExecutableTool, isFullMediaType, isNonNullable, isParsableJson, isProviderReference, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mapReasoningToProviderBudget, mapReasoningToProviderEffort, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, resolveFullMediaType, resolveProviderReference, safeParseJSON, safeValidateTypes, serializeModelOptions, stripFileExtension, tool, validateDownloadUrl, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.js

@@ -876,7 +876,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "5.0.0-canary.43" : "0.0.0-test";
+var VERSION = true ? "5.0.0-canary.45" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;
@@ -2148,16 +2148,18 @@ var parsePipelineDef = (def, refs) => {
   } else if (refs.pipeStrategy === "output") {
     return parseDef(def.out._def, refs);
   }
-  const a = parseDef(def.in._def, {
+  const inputSchema = parseDef(def.in._def, {
     ...refs,
     currentPath: [...refs.currentPath, "allOf", "0"]
   });
-  const b = parseDef(def.out._def, {
+  const outputSchema = parseDef(def.out._def, {
     ...refs,
-    currentPath: [...refs.currentPath, "allOf", a ? "1" : "0"]
+    currentPath: [...refs.currentPath, "allOf", inputSchema ? "1" : "0"]
   });
   return {
-    allOf: [a, b].filter((x) => x !== void 0)
+    allOf: [inputSchema, outputSchema].filter(
+      (schema) => schema !== void 0
+    )
   };
 };