@ai-sdk/provider-utils 5.0.0-canary.40 → 5.0.0-canary.41

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @ai-sdk/provider-utils
 
+## 5.0.0-canary.41
+
+### Patch Changes
+
+- 28dfa06: fix: support tools with optional context
+- e93fa91: rename Sandbox.executeCommand to Sandbox.runCommand
+
 ## 5.0.0-canary.40
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1293,9 +1293,9 @@ type Experimental_Sandbox = {
      */
     readonly description: string;
     /**
-     * Execute a command in the sandbox.
+     * Run a command in the sandbox.
      */
-    readonly executeCommand: (options: {
+    readonly runCommand: (options: {
         /**
          * Command to execute in the sandbox.
          */
@@ -1971,10 +1971,25 @@ type ExecutableTool<TOOL extends Tool = Tool> = TOOL & {
  */
 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.
+ */
+type IsAny<T> = 0 extends 1 & T ? true : false;
+/**
+ * Detects exact empty object contexts, including `{}` combined with
+ * `undefined`, which do not provide tool-specific context properties.
+ */
+type IsEmptyObject<T> = keyof NonNullable<T> extends never ? true : false;
+/**
+ * Detects context types that come from omitted or broad context declarations
+ * rather than a concrete tool context schema.
+ */
+type IsUntypedContext<CONTEXT> = IsAny<CONTEXT> extends true ? true : unknown extends CONTEXT ? true : IsEmptyObject<CONTEXT> extends true ? true : string extends keyof CONTEXT ? CONTEXT extends Context ? true : false : false;
 /**
  * Infer the context type of a tool.
  */
-type InferToolContext<TOOL extends Tool> = TOOL extends Tool<any, any, infer CONTEXT> ? HasRequiredKey<CONTEXT> extends true ? CONTEXT : never : never;
+type InferToolContext<TOOL extends Tool> = TOOL extends Tool<any, any, infer CONTEXT> ? IsUntypedContext<CONTEXT> extends true ? never : CONTEXT : never;
 
 /**
  * Infer the input type of a tool.
@@ -2017,16 +2032,36 @@ declare function executeTool<TOOL extends Tool>({ tool, input, options, }: {
  */
 type ToolSet = Record<string, (Tool<never, never, any> | Tool<any, any, any> | Tool<any, never, any> | Tool<never, any, any>) & Pick<Tool<any, any, any>, 'execute' | 'onInputAvailable' | 'onInputStart' | 'onInputDelta' | 'needsApproval'>>;
 
+/**
+ * Builds the required portion of the tool context map for tools whose context
+ * type does not include `undefined`.
+ */
+type RequiredToolSetContext<TOOLS extends ToolSet> = {
+    [K in keyof TOOLS as InferToolContext<NoInfer<TOOLS[K]>> extends never ? never : undefined extends InferToolContext<NoInfer<TOOLS[K]>> ? never : K]: InferToolContext<NoInfer<TOOLS[K]>>;
+};
+/**
+ * Builds the optional portion of the tool context map for tools whose context
+ * object itself may be `undefined`.
+ */
+type OptionalToolSetContext<TOOLS extends ToolSet> = {
+    [K in keyof TOOLS as InferToolContext<NoInfer<TOOLS[K]>> extends never ? never : undefined extends InferToolContext<NoInfer<TOOLS[K]>> ? K : never]?: InferToolContext<NoInfer<TOOLS[K]>>;
+};
+/**
+ * Flattens intersected mapped types so type equality assertions and editor
+ * hovers show the resulting object shape.
+ */
+type Normalize<OBJECT> = {
+    [KEY in keyof OBJECT]: OBJECT[KEY];
+};
 /**
  * Infer the context type for a tool set.
  *
- * The inferred type maps each tool name to its required context type.
+ * The inferred type maps each contextual tool name to its context type.
  *
- * Tools without required context properties are omitted from the result.
+ * Tools without concrete context are omitted. Tool contexts that include
+ * `undefined` are represented as optional properties.
  */
-type InferToolSetContext<TOOLS extends ToolSet> = {
-    [K in keyof TOOLS as InferToolContext<NoInfer<TOOLS[K]>> extends never ? never : K]: InferToolContext<NoInfer<TOOLS[K]>>;
-};
+type InferToolSetContext<TOOLS extends ToolSet> = Normalize<RequiredToolSetContext<TOOLS> & OptionalToolSetContext<TOOLS>>;
 
 /**
  * Typed tool call that is returned by generateText and streamText.

package/dist/index.js

@@ -862,7 +862,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "5.0.0-canary.40" : "0.0.0-test";
+var VERSION = true ? "5.0.0-canary.41" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/provider-utils",
-  "version": "5.0.0-canary.40",
+  "version": "5.0.0-canary.41",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,

package/src/types/infer-tool-context.ts

@@ -1,12 +1,41 @@
-import type { HasRequiredKey } from '../has-required-key';
+import type { Context } from './context';
 import type { Tool } from './tool';
 
+/**
+ * Detects the `any` type so untyped tools can be treated as having no explicit
+ * context type.
+ */
+type IsAny<T> = 0 extends 1 & T ? true : false;
+
+/**
+ * Detects exact empty object contexts, including `{}` combined with
+ * `undefined`, which do not provide tool-specific context properties.
+ */
+type IsEmptyObject<T> = keyof NonNullable<T> extends never ? true : false;
+
+/**
+ * Detects context types that come from omitted or broad context declarations
+ * rather than a concrete tool context schema.
+ */
+type IsUntypedContext<CONTEXT> =
+  IsAny<CONTEXT> extends true
+    ? true
+    : unknown extends CONTEXT
+      ? true
+      : IsEmptyObject<CONTEXT> extends true
+        ? true
+        : string extends keyof CONTEXT
+          ? CONTEXT extends Context
+            ? true
+            : false
+          : false;
+
 /**
  * Infer the context type of a tool.
  */
 export type InferToolContext<TOOL extends Tool> =
   TOOL extends Tool<any, any, infer CONTEXT>
-    ? HasRequiredKey<CONTEXT> extends true
-      ? CONTEXT
-      : never
+    ? IsUntypedContext<CONTEXT> extends true
+      ? never
+      : CONTEXT
     : never;

package/src/types/infer-tool-set-context.ts

@@ -2,14 +2,43 @@ import type { InferToolContext } from './infer-tool-context';
 import type { ToolSet } from './tool-set';
 
 /**
- * Infer the context type for a tool set.
- *
- * The inferred type maps each tool name to its required context type.
- *
- * Tools without required context properties are omitted from the result.
+ * Builds the required portion of the tool context map for tools whose context
+ * type does not include `undefined`.
+ */
+type RequiredToolSetContext<TOOLS extends ToolSet> = {
+  [K in keyof TOOLS as InferToolContext<NoInfer<TOOLS[K]>> extends never
+    ? never
+    : undefined extends InferToolContext<NoInfer<TOOLS[K]>>
+      ? never
+      : K]: InferToolContext<NoInfer<TOOLS[K]>>;
+};
+
+/**
+ * Builds the optional portion of the tool context map for tools whose context
+ * object itself may be `undefined`.
  */
-export type InferToolSetContext<TOOLS extends ToolSet> = {
+type OptionalToolSetContext<TOOLS extends ToolSet> = {
   [K in keyof TOOLS as InferToolContext<NoInfer<TOOLS[K]>> extends never
     ? never
-    : K]: InferToolContext<NoInfer<TOOLS[K]>>;
+    : undefined extends InferToolContext<NoInfer<TOOLS[K]>>
+      ? K
+      : never]?: InferToolContext<NoInfer<TOOLS[K]>>;
 };
+
+/**
+ * Flattens intersected mapped types so type equality assertions and editor
+ * hovers show the resulting object shape.
+ */
+type Normalize<OBJECT> = { [KEY in keyof OBJECT]: OBJECT[KEY] };
+
+/**
+ * Infer the context type for a tool set.
+ *
+ * The inferred type maps each contextual tool name to its context type.
+ *
+ * Tools without concrete context are omitted. Tool contexts that include
+ * `undefined` are represented as optional properties.
+ */
+export type InferToolSetContext<TOOLS extends ToolSet> = Normalize<
+  RequiredToolSetContext<TOOLS> & OptionalToolSetContext<TOOLS>
+>;

package/src/types/sandbox.ts

@@ -10,9 +10,9 @@ export type Experimental_Sandbox = {
   readonly description: string;
 
   /**
-   * Execute a command in the sandbox.
+   * Run a command in the sandbox.
    */
-  readonly executeCommand: (options: {
+  readonly runCommand: (options: {
     /**
      * Command to execute in the sandbox.
      */