@tanstack/openai-base 0.7.0 → 0.8.1

package/dist/esm/tools/computer-use-tool.d.ts

@@ -1,4 +1,4 @@
-import { ComputerTool as ComputerUseToolConfig } from 'openai/resources/responses/responses';
+import { ComputerUsePreviewTool as ComputerUseToolConfig } from 'openai/resources/responses/responses';
 import { Tool } from '@tanstack/ai';
 export type { ComputerUseToolConfig };
 /** @deprecated Renamed to `ComputerUseToolConfig`. Will be removed in a future release. */

package/dist/esm/tools/computer-use-tool.js.map

@@ -1 +1 @@
-{"version":3,"file":"computer-use-tool.js","sources":["../../../src/tools/computer-use-tool.ts"],"sourcesContent":["import type { ComputerTool as ComputerUseToolConfig } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\nexport type { ComputerUseToolConfig }\n\n/** @deprecated Renamed to `ComputerUseToolConfig`. Will be removed in a future release. */\nexport type ComputerUseTool = ComputerUseToolConfig\n\n/**\n * Converts a standard Tool to OpenAI ComputerUseTool format\n */\nexport function convertComputerUseToolToAdapterFormat(\n  tool: Tool,\n): ComputerUseToolConfig {\n  const metadata = tool.metadata as ComputerUseToolConfig\n  return {\n    type: 'computer_use_preview',\n    display_height: metadata.display_height,\n    display_width: metadata.display_width,\n    environment: metadata.environment,\n  }\n}\n\n/**\n * Creates a standard Tool from ComputerUseTool parameters.\n *\n * Base (non-branded) factory. Providers that need branded return types should\n * re-wrap this in their own package.\n */\nexport function computerUseTool(toolData: ComputerUseToolConfig): Tool {\n  return {\n    name: 'computer_use_preview',\n    description: 'Control a virtual computer',\n    metadata: {\n      ...toolData,\n    },\n  }\n}\n"],"names":[],"mappings":"AAWO,SAAS,sCACd,MACuB;AACvB,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,MAAM;AAAA,IACN,gBAAgB,SAAS;AAAA,IACzB,eAAe,SAAS;AAAA,IACxB,aAAa,SAAS;AAAA,EAAA;AAE1B;AAQO,SAAS,gBAAgB,UAAuC;AACrE,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,MACR,GAAG;AAAA,IAAA;AAAA,EACL;AAEJ;"}
+{"version":3,"file":"computer-use-tool.js","sources":["../../../src/tools/computer-use-tool.ts"],"sourcesContent":["import type { ComputerUsePreviewTool as ComputerUseToolConfig } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\nexport type { ComputerUseToolConfig }\n\n/** @deprecated Renamed to `ComputerUseToolConfig`. Will be removed in a future release. */\nexport type ComputerUseTool = ComputerUseToolConfig\n\n/**\n * Converts a standard Tool to OpenAI ComputerUseTool format\n */\nexport function convertComputerUseToolToAdapterFormat(\n  tool: Tool,\n): ComputerUseToolConfig {\n  const metadata = tool.metadata as ComputerUseToolConfig\n  return {\n    type: 'computer_use_preview',\n    display_height: metadata.display_height,\n    display_width: metadata.display_width,\n    environment: metadata.environment,\n  }\n}\n\n/**\n * Creates a standard Tool from ComputerUseTool parameters.\n *\n * Base (non-branded) factory. Providers that need branded return types should\n * re-wrap this in their own package.\n */\nexport function computerUseTool(toolData: ComputerUseToolConfig): Tool {\n  return {\n    name: 'computer_use_preview',\n    description: 'Control a virtual computer',\n    metadata: {\n      ...toolData,\n    },\n  }\n}\n"],"names":[],"mappings":"AAWO,SAAS,sCACd,MACuB;AACvB,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,MAAM;AAAA,IACN,gBAAgB,SAAS;AAAA,IACzB,eAAe,SAAS;AAAA,IACxB,aAAa,SAAS;AAAA,EAAA;AAE1B;AAQO,SAAS,gBAAgB,UAAuC;AACrE,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,MACR,GAAG;AAAA,IAAA;AAAA,EACL;AAEJ;"}

package/dist/esm/tools/shell-tool.d.ts

@@ -4,13 +4,23 @@ export type { ShellToolConfig };
 /** @deprecated Renamed to `ShellToolConfig`. Will be removed in a future release. */
 export type ShellTool = ShellToolConfig;
 /**
- * Converts a standard Tool to OpenAI ShellTool format
+ * Config accepted by {@link shellTool}. `environment` mirrors the OpenAI
+ * Responses API shell tool environment (e.g. `container_auto` + `skills`).
+ * Typed via indexed access so it tracks the installed SDK without naming the
+ * union members directly.
  */
-export declare function convertShellToolToAdapterFormat(_tool: Tool): ShellToolConfig;
+export interface ShellToolFactoryConfig {
+    environment?: NonNullable<ShellToolConfig['environment']>;
+}
+/**
+ * Converts a standard Tool to OpenAI ShellTool format, preserving any
+ * `environment` (container config + skills) stored in metadata.
+ */
+export declare function convertShellToolToAdapterFormat(tool: Tool): ShellToolConfig;
 /**
  * Creates a standard Tool from ShellTool parameters.
  *
  * Base (non-branded) factory. Providers that need branded return types should
  * re-wrap this in their own package.
  */
-export declare function shellTool(): Tool;
+export declare function shellTool(config?: ShellToolFactoryConfig): Tool;

package/dist/esm/tools/shell-tool.js

@@ -1,13 +1,21 @@
-function convertShellToolToAdapterFormat(_tool) {
+function convertShellToolToAdapterFormat(tool) {
+  const metadata = tool.metadata ?? {};
   return {
-    type: "shell"
+    type: "shell",
+    ...metadata.environment !== void 0 && {
+      environment: metadata.environment
+    }
   };
 }
-function shellTool() {
+function shellTool(config = {}) {
   return {
     name: "shell",
     description: "Execute shell commands",
-    metadata: {}
+    metadata: {
+      ...config.environment !== void 0 && {
+        environment: config.environment
+      }
+    }
   };
 }
 export {

package/dist/esm/tools/shell-tool.js.map

@@ -1 +1 @@
-{"version":3,"file":"shell-tool.js","sources":["../../../src/tools/shell-tool.ts"],"sourcesContent":["import type { FunctionShellTool as ShellToolConfig } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\nexport type { ShellToolConfig }\n\n/** @deprecated Renamed to `ShellToolConfig`. Will be removed in a future release. */\nexport type ShellTool = ShellToolConfig\n\n/**\n * Converts a standard Tool to OpenAI ShellTool format\n */\nexport function convertShellToolToAdapterFormat(_tool: Tool): ShellToolConfig {\n  return {\n    type: 'shell',\n  }\n}\n\n/**\n * Creates a standard Tool from ShellTool parameters.\n *\n * Base (non-branded) factory. Providers that need branded return types should\n * re-wrap this in their own package.\n */\nexport function shellTool(): Tool {\n  return {\n    name: 'shell',\n    description: 'Execute shell commands',\n    metadata: {},\n  }\n}\n"],"names":[],"mappings":"AAWO,SAAS,gCAAgC,OAA8B;AAC5E,SAAO;AAAA,IACL,MAAM;AAAA,EAAA;AAEV;AAQO,SAAS,YAAkB;AAChC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU,CAAA;AAAA,EAAC;AAEf;"}
+{"version":3,"file":"shell-tool.js","sources":["../../../src/tools/shell-tool.ts"],"sourcesContent":["import type { FunctionShellTool as ShellToolConfig } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\nexport type { ShellToolConfig }\n\n/** @deprecated Renamed to `ShellToolConfig`. Will be removed in a future release. */\nexport type ShellTool = ShellToolConfig\n\n/**\n * Config accepted by {@link shellTool}. `environment` mirrors the OpenAI\n * Responses API shell tool environment (e.g. `container_auto` + `skills`).\n * Typed via indexed access so it tracks the installed SDK without naming the\n * union members directly.\n */\nexport interface ShellToolFactoryConfig {\n  environment?: NonNullable<ShellToolConfig['environment']>\n}\n\n/**\n * Converts a standard Tool to OpenAI ShellTool format, preserving any\n * `environment` (container config + skills) stored in metadata.\n */\nexport function convertShellToolToAdapterFormat(tool: Tool): ShellToolConfig {\n  const metadata = (tool.metadata ?? {}) as ShellToolFactoryConfig\n  return {\n    type: 'shell',\n    ...(metadata.environment !== undefined && {\n      environment: metadata.environment,\n    }),\n  }\n}\n\n/**\n * Creates a standard Tool from ShellTool parameters.\n *\n * Base (non-branded) factory. Providers that need branded return types should\n * re-wrap this in their own package.\n */\nexport function shellTool(config: ShellToolFactoryConfig = {}): Tool {\n  return {\n    name: 'shell',\n    description: 'Execute shell commands',\n    metadata: {\n      ...(config.environment !== undefined && {\n        environment: config.environment,\n      }),\n    },\n  }\n}\n"],"names":[],"mappings":"AAsBO,SAAS,gCAAgC,MAA6B;AAC3E,QAAM,WAAY,KAAK,YAAY,CAAA;AACnC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,GAAI,SAAS,gBAAgB,UAAa;AAAA,MACxC,aAAa,SAAS;AAAA,IAAA;AAAA,EACxB;AAEJ;AAQO,SAAS,UAAU,SAAiC,IAAU;AACnE,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,MACR,GAAI,OAAO,gBAAgB,UAAa;AAAA,QACtC,aAAa,OAAO;AAAA,MAAA;AAAA,IACtB;AAAA,EACF;AAEJ;"}

package/dist/esm/tools/tool-converter.js

@@ -43,7 +43,7 @@ function convertToolsToProviderFormat(tools) {
         case "mcp":
           return convertMCPToolToAdapterFormat(tool);
         case "shell":
-          return convertShellToolToAdapterFormat();
+          return convertShellToolToAdapterFormat(tool);
         case "web_search_preview":
           return convertWebSearchPreviewToolToAdapterFormat(tool);
         case "web_search":

package/dist/esm/tools/tool-converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"tool-converter.js","sources":["../../../src/tools/tool-converter.ts"],"sourcesContent":["import { convertApplyPatchToolToAdapterFormat } from './apply-patch-tool'\nimport { convertCodeInterpreterToolToAdapterFormat } from './code-interpreter-tool'\nimport { convertComputerUseToolToAdapterFormat } from './computer-use-tool'\nimport { convertCustomToolToAdapterFormat } from './custom-tool'\nimport { convertFileSearchToolToAdapterFormat } from './file-search-tool'\nimport { convertFunctionToolToAdapterFormat } from './function-tool'\nimport { convertImageGenerationToolToAdapterFormat } from './image-generation-tool'\nimport { convertLocalShellToolToAdapterFormat } from './local-shell-tool'\nimport { convertMCPToolToAdapterFormat } from './mcp-tool'\nimport { convertShellToolToAdapterFormat } from './shell-tool'\nimport { convertWebSearchPreviewToolToAdapterFormat } from './web-search-preview-tool'\nimport { convertWebSearchToolToAdapterFormat } from './web-search-tool'\nimport type { OpenAITool } from './index'\nimport type { Tool } from '@tanstack/ai'\n\nconst SPECIAL_TOOL_NAMES = new Set([\n  'apply_patch',\n  'code_interpreter',\n  'computer_use_preview',\n  'file_search',\n  'image_generation',\n  'local_shell',\n  'mcp',\n  'shell',\n  'web_search_preview',\n  'web_search',\n  'custom',\n])\n\n/**\n * Converts an array of standard Tools to OpenAI-specific format\n */\nexport function convertToolsToProviderFormat(\n  tools: Array<Tool>,\n): Array<OpenAITool> {\n  return tools.map((tool) => {\n    const toolName = tool.name\n\n    if (SPECIAL_TOOL_NAMES.has(toolName)) {\n      switch (toolName) {\n        case 'apply_patch':\n          return convertApplyPatchToolToAdapterFormat(tool)\n        case 'code_interpreter':\n          return convertCodeInterpreterToolToAdapterFormat(tool)\n        case 'computer_use_preview':\n          return convertComputerUseToolToAdapterFormat(tool)\n        case 'file_search':\n          return convertFileSearchToolToAdapterFormat(tool)\n        case 'image_generation':\n          return convertImageGenerationToolToAdapterFormat(tool)\n        case 'local_shell':\n          return convertLocalShellToolToAdapterFormat(tool)\n        case 'mcp':\n          return convertMCPToolToAdapterFormat(tool)\n        case 'shell':\n          return convertShellToolToAdapterFormat(tool)\n        case 'web_search_preview':\n          return convertWebSearchPreviewToolToAdapterFormat(tool)\n        case 'web_search':\n          return convertWebSearchToolToAdapterFormat(tool)\n        case 'custom':\n          return convertCustomToolToAdapterFormat(tool)\n      }\n    }\n\n    return convertFunctionToolToAdapterFormat(tool)\n  })\n}\n"],"names":[],"mappings":";;;;;;;;;;;;AAeA,MAAM,yCAAyB,IAAI;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAKM,SAAS,6BACd,OACmB;AACnB,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,WAAW,KAAK;AAEtB,QAAI,mBAAmB,IAAI,QAAQ,GAAG;AACpC,cAAQ,UAAA;AAAA,QACN,KAAK;AACH,iBAAO,qCAAyC;AAAA,QAClD,KAAK;AACH,iBAAO,0CAA0C,IAAI;AAAA,QACvD,KAAK;AACH,iBAAO,sCAAsC,IAAI;AAAA,QACnD,KAAK;AACH,iBAAO,qCAAqC,IAAI;AAAA,QAClD,KAAK;AACH,iBAAO,0CAA0C,IAAI;AAAA,QACvD,KAAK;AACH,iBAAO,qCAAyC;AAAA,QAClD,KAAK;AACH,iBAAO,8BAA8B,IAAI;AAAA,QAC3C,KAAK;AACH,iBAAO,gCAAoC;AAAA,QAC7C,KAAK;AACH,iBAAO,2CAA2C,IAAI;AAAA,QACxD,KAAK;AACH,iBAAO,oCAAoC,IAAI;AAAA,QACjD,KAAK;AACH,iBAAO,iCAAiC,IAAI;AAAA,MAAA;AAAA,IAElD;AAEA,WAAO,mCAAmC,IAAI;AAAA,EAChD,CAAC;AACH;"}
+{"version":3,"file":"tool-converter.js","sources":["../../../src/tools/tool-converter.ts"],"sourcesContent":["import { convertApplyPatchToolToAdapterFormat } from './apply-patch-tool'\nimport { convertCodeInterpreterToolToAdapterFormat } from './code-interpreter-tool'\nimport { convertComputerUseToolToAdapterFormat } from './computer-use-tool'\nimport { convertCustomToolToAdapterFormat } from './custom-tool'\nimport { convertFileSearchToolToAdapterFormat } from './file-search-tool'\nimport { convertFunctionToolToAdapterFormat } from './function-tool'\nimport { convertImageGenerationToolToAdapterFormat } from './image-generation-tool'\nimport { convertLocalShellToolToAdapterFormat } from './local-shell-tool'\nimport { convertMCPToolToAdapterFormat } from './mcp-tool'\nimport { convertShellToolToAdapterFormat } from './shell-tool'\nimport { convertWebSearchPreviewToolToAdapterFormat } from './web-search-preview-tool'\nimport { convertWebSearchToolToAdapterFormat } from './web-search-tool'\nimport type { OpenAITool } from './index'\nimport type { Tool } from '@tanstack/ai'\n\nconst SPECIAL_TOOL_NAMES = new Set([\n  'apply_patch',\n  'code_interpreter',\n  'computer_use_preview',\n  'file_search',\n  'image_generation',\n  'local_shell',\n  'mcp',\n  'shell',\n  'web_search_preview',\n  'web_search',\n  'custom',\n])\n\n/**\n * Converts an array of standard Tools to OpenAI-specific format\n */\nexport function convertToolsToProviderFormat(\n  tools: Array<Tool>,\n): Array<OpenAITool> {\n  return tools.map((tool) => {\n    const toolName = tool.name\n\n    if (SPECIAL_TOOL_NAMES.has(toolName)) {\n      switch (toolName) {\n        case 'apply_patch':\n          return convertApplyPatchToolToAdapterFormat(tool)\n        case 'code_interpreter':\n          return convertCodeInterpreterToolToAdapterFormat(tool)\n        case 'computer_use_preview':\n          return convertComputerUseToolToAdapterFormat(tool)\n        case 'file_search':\n          return convertFileSearchToolToAdapterFormat(tool)\n        case 'image_generation':\n          return convertImageGenerationToolToAdapterFormat(tool)\n        case 'local_shell':\n          return convertLocalShellToolToAdapterFormat(tool)\n        case 'mcp':\n          return convertMCPToolToAdapterFormat(tool)\n        case 'shell':\n          return convertShellToolToAdapterFormat(tool)\n        case 'web_search_preview':\n          return convertWebSearchPreviewToolToAdapterFormat(tool)\n        case 'web_search':\n          return convertWebSearchToolToAdapterFormat(tool)\n        case 'custom':\n          return convertCustomToolToAdapterFormat(tool)\n      }\n    }\n\n    return convertFunctionToolToAdapterFormat(tool)\n  })\n}\n"],"names":[],"mappings":";;;;;;;;;;;;AAeA,MAAM,yCAAyB,IAAI;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAKM,SAAS,6BACd,OACmB;AACnB,SAAO,MAAM,IAAI,CAAC,SAAS;AACzB,UAAM,WAAW,KAAK;AAEtB,QAAI,mBAAmB,IAAI,QAAQ,GAAG;AACpC,cAAQ,UAAA;AAAA,QACN,KAAK;AACH,iBAAO,qCAAyC;AAAA,QAClD,KAAK;AACH,iBAAO,0CAA0C,IAAI;AAAA,QACvD,KAAK;AACH,iBAAO,sCAAsC,IAAI;AAAA,QACnD,KAAK;AACH,iBAAO,qCAAqC,IAAI;AAAA,QAClD,KAAK;AACH,iBAAO,0CAA0C,IAAI;AAAA,QACvD,KAAK;AACH,iBAAO,qCAAyC;AAAA,QAClD,KAAK;AACH,iBAAO,8BAA8B,IAAI;AAAA,QAC3C,KAAK;AACH,iBAAO,gCAAgC,IAAI;AAAA,QAC7C,KAAK;AACH,iBAAO,2CAA2C,IAAI;AAAA,QACxD,KAAK;AACH,iBAAO,oCAAoC,IAAI;AAAA,QACjD,KAAK;AACH,iBAAO,iCAAiC,IAAI;AAAA,MAAA;AAAA,IAElD;AAEA,WAAO,mCAAmC,IAAI;AAAA,EAChD,CAAC;AACH;"}

package/dist/esm/utils/schema-converter.d.ts

@@ -4,6 +4,7 @@
  * - All properties must be in the `required` array
  * - Optional fields should have null added to their type union
  * - additionalProperties must be false for objects
+ * - String `format` keywords must be from a fixed allowlist (others are stripped)
  *
  * @param schema - JSON schema to transform
  * @param originalRequired - Original required array (to know which fields were optional)

package/dist/esm/utils/schema-converter.js

@@ -1,4 +1,30 @@
+const SUPPORTED_STRING_FORMATS = /* @__PURE__ */ new Set([
+  "date-time",
+  "time",
+  "date",
+  "duration",
+  "email",
+  "hostname",
+  "ipv4",
+  "ipv6",
+  "uuid"
+]);
+function stripUnsupportedFormats(node) {
+  if (Array.isArray(node)) return node.map(stripUnsupportedFormats);
+  if (node === null || typeof node !== "object") return node;
+  const out = {};
+  for (const [key, value] of Object.entries(node)) {
+    if (key === "format" && typeof value === "string" && !SUPPORTED_STRING_FORMATS.has(value)) {
+      continue;
+    }
+    out[key] = stripUnsupportedFormats(value);
+  }
+  return out;
+}
 function makeStructuredOutputCompatible(schema, originalRequired) {
+  return stripUnsupportedFormats(coerceStrictSchema(schema, originalRequired));
+}
+function coerceStrictSchema(schema, originalRequired) {
   const result = { ...schema };
   const required = originalRequired ?? (Array.isArray(result["required"]) ? result["required"] : []);
   if (result.type === "object" && result.properties) {
@@ -8,17 +34,14 @@ function makeStructuredOutputCompatible(schema, originalRequired) {
       let prop = properties[propName];
       const wasOptional = !required.includes(propName);
       if (prop.type === "object" && prop.properties) {
-        prop = makeStructuredOutputCompatible(prop, prop.required || []);
+        prop = coerceStrictSchema(prop, prop.required || []);
       } else if (prop.type === "array" && prop.items) {
         prop = {
           ...prop,
-          items: makeStructuredOutputCompatible(
-            prop.items,
-            prop.items.required || []
-          )
+          items: coerceStrictSchema(prop.items, prop.items.required || [])
         };
       } else if (prop.anyOf) {
-        prop = makeStructuredOutputCompatible(prop, prop.required || []);
+        prop = coerceStrictSchema(prop, prop.required || []);
       } else if (prop.oneOf) {
         throw new Error(
           "oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types"
@@ -42,14 +65,11 @@ function makeStructuredOutputCompatible(schema, originalRequired) {
     result.additionalProperties = false;
   }
   if (result.type === "array" && result.items) {
-    result.items = makeStructuredOutputCompatible(
-      result.items,
-      result.items.required || []
-    );
+    result.items = coerceStrictSchema(result.items, result.items.required || []);
   }
   if (result.anyOf && Array.isArray(result.anyOf)) {
     result.anyOf = result.anyOf.map(
-      (variant) => makeStructuredOutputCompatible(variant, variant.required || [])
+      (variant) => coerceStrictSchema(variant, variant.required || [])
     );
   }
   if (result.oneOf) {

package/dist/esm/utils/schema-converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema-converter.js","sources":["../../../src/utils/schema-converter.ts"],"sourcesContent":["/**\n * Transform a JSON schema to be compatible with OpenAI's structured output requirements.\n * OpenAI requires:\n * - All properties must be in the `required` array\n * - Optional fields should have null added to their type union\n * - additionalProperties must be false for objects\n *\n * @param schema - JSON schema to transform\n * @param originalRequired - Original required array (to know which fields were optional)\n * @returns Transformed schema compatible with OpenAI structured output\n */\nexport function makeStructuredOutputCompatible(\n  schema: Record<string, any>,\n  originalRequired?: Array<string>,\n): Record<string, any> {\n  const result = { ...schema }\n  const required =\n    originalRequired ??\n    (Array.isArray(result['required']) ? result['required'] : [])\n\n  if (result.type === 'object' && result.properties) {\n    const properties = { ...result.properties }\n    const allPropertyNames = Object.keys(properties)\n\n    for (const propName of allPropertyNames) {\n      let prop = properties[propName]\n      const wasOptional = !required.includes(propName)\n\n      // Step 1: Recurse into nested structures\n      if (prop.type === 'object' && prop.properties) {\n        prop = makeStructuredOutputCompatible(prop, prop.required || [])\n      } else if (prop.type === 'array' && prop.items) {\n        prop = {\n          ...prop,\n          items: makeStructuredOutputCompatible(\n            prop.items,\n            prop.items.required || [],\n          ),\n        }\n      } else if (prop.anyOf) {\n        prop = makeStructuredOutputCompatible(prop, prop.required || [])\n      } else if (prop.oneOf) {\n        throw new Error(\n          'oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types',\n        )\n      }\n\n      // Step 2: Apply null-widening for optional properties (after recursion)\n      if (wasOptional) {\n        if (prop.anyOf) {\n          // For anyOf, add a null variant if not already present\n          if (!prop.anyOf.some((v: any) => v.type === 'null')) {\n            prop = { ...prop, anyOf: [...prop.anyOf, { type: 'null' }] }\n          }\n        } else if (prop.type && !Array.isArray(prop.type)) {\n          prop = { ...prop, type: [prop.type, 'null'] }\n        } else if (Array.isArray(prop.type) && !prop.type.includes('null')) {\n          prop = { ...prop, type: [...prop.type, 'null'] }\n        }\n      }\n\n      properties[propName] = prop\n    }\n\n    result.properties = properties\n    result.required = allPropertyNames\n    result.additionalProperties = false\n  }\n\n  if (result.type === 'array' && result.items) {\n    result.items = makeStructuredOutputCompatible(\n      result.items,\n      result.items.required || [],\n    )\n  }\n\n  if (result.anyOf && Array.isArray(result.anyOf)) {\n    result.anyOf = result.anyOf.map((variant) =>\n      makeStructuredOutputCompatible(variant, variant.required || []),\n    )\n  }\n\n  if (result.oneOf) {\n    throw new Error(\n      'oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types',\n    )\n  }\n\n  return result\n}\n"],"names":[],"mappings":"AAWO,SAAS,+BACd,QACA,kBACqB;AACrB,QAAM,SAAS,EAAE,GAAG,OAAA;AACpB,QAAM,WACJ,qBACC,MAAM,QAAQ,OAAO,UAAU,CAAC,IAAI,OAAO,UAAU,IAAI,CAAA;AAE5D,MAAI,OAAO,SAAS,YAAY,OAAO,YAAY;AACjD,UAAM,aAAa,EAAE,GAAG,OAAO,WAAA;AAC/B,UAAM,mBAAmB,OAAO,KAAK,UAAU;AAE/C,eAAW,YAAY,kBAAkB;AACvC,UAAI,OAAO,WAAW,QAAQ;AAC9B,YAAM,cAAc,CAAC,SAAS,SAAS,QAAQ;AAG/C,UAAI,KAAK,SAAS,YAAY,KAAK,YAAY;AAC7C,eAAO,+BAA+B,MAAM,KAAK,YAAY,CAAA,CAAE;AAAA,MACjE,WAAW,KAAK,SAAS,WAAW,KAAK,OAAO;AAC9C,eAAO;AAAA,UACL,GAAG;AAAA,UACH,OAAO;AAAA,YACL,KAAK;AAAA,YACL,KAAK,MAAM,YAAY,CAAA;AAAA,UAAC;AAAA,QAC1B;AAAA,MAEJ,WAAW,KAAK,OAAO;AACrB,eAAO,+BAA+B,MAAM,KAAK,YAAY,CAAA,CAAE;AAAA,MACjE,WAAW,KAAK,OAAO;AACrB,cAAM,IAAI;AAAA,UACR;AAAA,QAAA;AAAA,MAEJ;AAGA,UAAI,aAAa;AACf,YAAI,KAAK,OAAO;AAEd,cAAI,CAAC,KAAK,MAAM,KAAK,CAAC,MAAW,EAAE,SAAS,MAAM,GAAG;AACnD,mBAAO,EAAE,GAAG,MAAM,OAAO,CAAC,GAAG,KAAK,OAAO,EAAE,MAAM,OAAA,CAAQ,EAAA;AAAA,UAC3D;AAAA,QACF,WAAW,KAAK,QAAQ,CAAC,MAAM,QAAQ,KAAK,IAAI,GAAG;AACjD,iBAAO,EAAE,GAAG,MAAM,MAAM,CAAC,KAAK,MAAM,MAAM,EAAA;AAAA,QAC5C,WAAW,MAAM,QAAQ,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,MAAM,GAAG;AAClE,iBAAO,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,KAAK,MAAM,MAAM,EAAA;AAAA,QAC/C;AAAA,MACF;AAEA,iBAAW,QAAQ,IAAI;AAAA,IACzB;AAEA,WAAO,aAAa;AACpB,WAAO,WAAW;AAClB,WAAO,uBAAuB;AAAA,EAChC;AAEA,MAAI,OAAO,SAAS,WAAW,OAAO,OAAO;AAC3C,WAAO,QAAQ;AAAA,MACb,OAAO;AAAA,MACP,OAAO,MAAM,YAAY,CAAA;AAAA,IAAC;AAAA,EAE9B;AAEA,MAAI,OAAO,SAAS,MAAM,QAAQ,OAAO,KAAK,GAAG;AAC/C,WAAO,QAAQ,OAAO,MAAM;AAAA,MAAI,CAAC,YAC/B,+BAA+B,SAAS,QAAQ,YAAY,CAAA,CAAE;AAAA,IAAA;AAAA,EAElE;AAEA,MAAI,OAAO,OAAO;AAChB,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,SAAO;AACT;"}
+{"version":3,"file":"schema-converter.js","sources":["../../../src/utils/schema-converter.ts"],"sourcesContent":["/**\n * String `format` values accepted by OpenAI's strict Structured Outputs subset.\n * Any other format (e.g. \"uri\", \"uri-reference\", \"regex\") causes the API to\n * reject the whole request with `400 ... '<format>' is not a valid format`.\n * MCP servers and hand-written tools routinely declare such formats, so we strip\n * the unsupported ones before sending. See:\n * https://platform.openai.com/docs/guides/structured-outputs#supported-properties\n */\nconst SUPPORTED_STRING_FORMATS = new Set([\n  'date-time',\n  'time',\n  'date',\n  'duration',\n  'email',\n  'hostname',\n  'ipv4',\n  'ipv6',\n  'uuid',\n])\n\n/**\n * Recursively drop JSON-Schema `format` keywords whose value isn't in OpenAI's\n * strict-mode allowlist. Pure — returns a fresh tree and never mutates `node`,\n * so the caller's original tool definition is left intact.\n *\n * A property *named* `format` always has a schema (object/boolean) value, never\n * a bare string, so it is preserved and recursed into; only the `format`\n * *keyword* (whose value is a string) is subject to removal.\n */\nfunction stripUnsupportedFormats(node: any): any {\n  if (Array.isArray(node)) return node.map(stripUnsupportedFormats)\n  if (node === null || typeof node !== 'object') return node\n\n  const out: Record<string, any> = {}\n  for (const [key, value] of Object.entries(node)) {\n    if (\n      key === 'format' &&\n      typeof value === 'string' &&\n      !SUPPORTED_STRING_FORMATS.has(value)\n    ) {\n      continue\n    }\n    out[key] = stripUnsupportedFormats(value)\n  }\n  return out\n}\n\n/**\n * Transform a JSON schema to be compatible with OpenAI's structured output requirements.\n * OpenAI requires:\n * - All properties must be in the `required` array\n * - Optional fields should have null added to their type union\n * - additionalProperties must be false for objects\n * - String `format` keywords must be from a fixed allowlist (others are stripped)\n *\n * @param schema - JSON schema to transform\n * @param originalRequired - Original required array (to know which fields were optional)\n * @returns Transformed schema compatible with OpenAI structured output\n */\nexport function makeStructuredOutputCompatible(\n  schema: Record<string, any>,\n  originalRequired?: Array<string>,\n): Record<string, any> {\n  return stripUnsupportedFormats(coerceStrictSchema(schema, originalRequired))\n}\n\n/**\n * Strict-mode structural rewrite (required widening, nullability,\n * additionalProperties). Kept private so the public entry point can apply the\n * format-stripping pass exactly once over the fully-rewritten tree.\n */\nfunction coerceStrictSchema(\n  schema: Record<string, any>,\n  originalRequired?: Array<string>,\n): Record<string, any> {\n  const result = { ...schema }\n  const required =\n    originalRequired ??\n    (Array.isArray(result['required']) ? result['required'] : [])\n\n  if (result.type === 'object' && result.properties) {\n    const properties = { ...result.properties }\n    const allPropertyNames = Object.keys(properties)\n\n    for (const propName of allPropertyNames) {\n      let prop = properties[propName]\n      const wasOptional = !required.includes(propName)\n\n      // Step 1: Recurse into nested structures\n      if (prop.type === 'object' && prop.properties) {\n        prop = coerceStrictSchema(prop, prop.required || [])\n      } else if (prop.type === 'array' && prop.items) {\n        prop = {\n          ...prop,\n          items: coerceStrictSchema(prop.items, prop.items.required || []),\n        }\n      } else if (prop.anyOf) {\n        prop = coerceStrictSchema(prop, prop.required || [])\n      } else if (prop.oneOf) {\n        throw new Error(\n          'oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types',\n        )\n      }\n\n      // Step 2: Apply null-widening for optional properties (after recursion)\n      if (wasOptional) {\n        if (prop.anyOf) {\n          // For anyOf, add a null variant if not already present\n          if (!prop.anyOf.some((v: any) => v.type === 'null')) {\n            prop = { ...prop, anyOf: [...prop.anyOf, { type: 'null' }] }\n          }\n        } else if (prop.type && !Array.isArray(prop.type)) {\n          prop = { ...prop, type: [prop.type, 'null'] }\n        } else if (Array.isArray(prop.type) && !prop.type.includes('null')) {\n          prop = { ...prop, type: [...prop.type, 'null'] }\n        }\n      }\n\n      properties[propName] = prop\n    }\n\n    result.properties = properties\n    result.required = allPropertyNames\n    result.additionalProperties = false\n  }\n\n  if (result.type === 'array' && result.items) {\n    result.items = coerceStrictSchema(result.items, result.items.required || [])\n  }\n\n  if (result.anyOf && Array.isArray(result.anyOf)) {\n    result.anyOf = result.anyOf.map((variant) =>\n      coerceStrictSchema(variant, variant.required || []),\n    )\n  }\n\n  if (result.oneOf) {\n    throw new Error(\n      'oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types',\n    )\n  }\n\n  return result\n}\n"],"names":[],"mappings":"AAQA,MAAM,+CAA+B,IAAI;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAWD,SAAS,wBAAwB,MAAgB;AAC/C,MAAI,MAAM,QAAQ,IAAI,EAAG,QAAO,KAAK,IAAI,uBAAuB;AAChE,MAAI,SAAS,QAAQ,OAAO,SAAS,SAAU,QAAO;AAEtD,QAAM,MAA2B,CAAA;AACjC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,IAAI,GAAG;AAC/C,QACE,QAAQ,YACR,OAAO,UAAU,YACjB,CAAC,yBAAyB,IAAI,KAAK,GACnC;AACA;AAAA,IACF;AACA,QAAI,GAAG,IAAI,wBAAwB,KAAK;AAAA,EAC1C;AACA,SAAO;AACT;AAcO,SAAS,+BACd,QACA,kBACqB;AACrB,SAAO,wBAAwB,mBAAmB,QAAQ,gBAAgB,CAAC;AAC7E;AAOA,SAAS,mBACP,QACA,kBACqB;AACrB,QAAM,SAAS,EAAE,GAAG,OAAA;AACpB,QAAM,WACJ,qBACC,MAAM,QAAQ,OAAO,UAAU,CAAC,IAAI,OAAO,UAAU,IAAI,CAAA;AAE5D,MAAI,OAAO,SAAS,YAAY,OAAO,YAAY;AACjD,UAAM,aAAa,EAAE,GAAG,OAAO,WAAA;AAC/B,UAAM,mBAAmB,OAAO,KAAK,UAAU;AAE/C,eAAW,YAAY,kBAAkB;AACvC,UAAI,OAAO,WAAW,QAAQ;AAC9B,YAAM,cAAc,CAAC,SAAS,SAAS,QAAQ;AAG/C,UAAI,KAAK,SAAS,YAAY,KAAK,YAAY;AAC7C,eAAO,mBAAmB,MAAM,KAAK,YAAY,CAAA,CAAE;AAAA,MACrD,WAAW,KAAK,SAAS,WAAW,KAAK,OAAO;AAC9C,eAAO;AAAA,UACL,GAAG;AAAA,UACH,OAAO,mBAAmB,KAAK,OAAO,KAAK,MAAM,YAAY,CAAA,CAAE;AAAA,QAAA;AAAA,MAEnE,WAAW,KAAK,OAAO;AACrB,eAAO,mBAAmB,MAAM,KAAK,YAAY,CAAA,CAAE;AAAA,MACrD,WAAW,KAAK,OAAO;AACrB,cAAM,IAAI;AAAA,UACR;AAAA,QAAA;AAAA,MAEJ;AAGA,UAAI,aAAa;AACf,YAAI,KAAK,OAAO;AAEd,cAAI,CAAC,KAAK,MAAM,KAAK,CAAC,MAAW,EAAE,SAAS,MAAM,GAAG;AACnD,mBAAO,EAAE,GAAG,MAAM,OAAO,CAAC,GAAG,KAAK,OAAO,EAAE,MAAM,OAAA,CAAQ,EAAA;AAAA,UAC3D;AAAA,QACF,WAAW,KAAK,QAAQ,CAAC,MAAM,QAAQ,KAAK,IAAI,GAAG;AACjD,iBAAO,EAAE,GAAG,MAAM,MAAM,CAAC,KAAK,MAAM,MAAM,EAAA;AAAA,QAC5C,WAAW,MAAM,QAAQ,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,MAAM,GAAG;AAClE,iBAAO,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,KAAK,MAAM,MAAM,EAAA;AAAA,QAC/C;AAAA,MACF;AAEA,iBAAW,QAAQ,IAAI;AAAA,IACzB;AAEA,WAAO,aAAa;AACpB,WAAO,WAAW;AAClB,WAAO,uBAAuB;AAAA,EAChC;AAEA,MAAI,OAAO,SAAS,WAAW,OAAO,OAAO;AAC3C,WAAO,QAAQ,mBAAmB,OAAO,OAAO,OAAO,MAAM,YAAY,EAAE;AAAA,EAC7E;AAEA,MAAI,OAAO,SAAS,MAAM,QAAQ,OAAO,KAAK,GAAG;AAC/C,WAAO,QAAQ,OAAO,MAAM;AAAA,MAAI,CAAC,YAC/B,mBAAmB,SAAS,QAAQ,YAAY,CAAA,CAAE;AAAA,IAAA;AAAA,EAEtD;AAEA,MAAI,OAAO,OAAO;AAChB,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,SAAO;AACT;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/openai-base",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "Shared OpenAI SDK base adapters for TanStack AI providers using Chat Completions and Responses APIs.",
   "author": "",
   "license": "MIT",
@@ -35,17 +35,17 @@
     "structured-outputs"
   ],
   "dependencies": {
-    "openai": "^6.9.1",
+    "openai": "^6.41.0",
     "@tanstack/ai-utils": "0.2.1"
   },
   "peerDependencies": {
-    "@tanstack/ai": "^0.27.0"
+    "@tanstack/ai": "^0.28.0"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "4.0.14",
     "vite": "^7.3.3",
     "zod": "^4.2.0",
-    "@tanstack/ai": "0.27.0"
+    "@tanstack/ai": "0.28.0"
   },
   "scripts": {
     "build": "vite build",

package/src/tools/computer-use-tool.ts

@@ -1,4 +1,4 @@
-import type { ComputerTool as ComputerUseToolConfig } from 'openai/resources/responses/responses'
+import type { ComputerUsePreviewTool as ComputerUseToolConfig } from 'openai/resources/responses/responses'
 import type { Tool } from '@tanstack/ai'
 
 export type { ComputerUseToolConfig }

package/src/tools/shell-tool.ts

@@ -7,11 +7,26 @@ export type { ShellToolConfig }
 export type ShellTool = ShellToolConfig
 
 /**
- * Converts a standard Tool to OpenAI ShellTool format
+ * Config accepted by {@link shellTool}. `environment` mirrors the OpenAI
+ * Responses API shell tool environment (e.g. `container_auto` + `skills`).
+ * Typed via indexed access so it tracks the installed SDK without naming the
+ * union members directly.
  */
-export function convertShellToolToAdapterFormat(_tool: Tool): ShellToolConfig {
+export interface ShellToolFactoryConfig {
+  environment?: NonNullable<ShellToolConfig['environment']>
+}
+
+/**
+ * Converts a standard Tool to OpenAI ShellTool format, preserving any
+ * `environment` (container config + skills) stored in metadata.
+ */
+export function convertShellToolToAdapterFormat(tool: Tool): ShellToolConfig {
+  const metadata = (tool.metadata ?? {}) as ShellToolFactoryConfig
   return {
     type: 'shell',
+    ...(metadata.environment !== undefined && {
+      environment: metadata.environment,
+    }),
   }
 }
 
@@ -21,10 +36,14 @@ export function convertShellToolToAdapterFormat(_tool: Tool): ShellToolConfig {
  * Base (non-branded) factory. Providers that need branded return types should
  * re-wrap this in their own package.
  */
-export function shellTool(): Tool {
+export function shellTool(config: ShellToolFactoryConfig = {}): Tool {
   return {
     name: 'shell',
     description: 'Execute shell commands',
-    metadata: {},
+    metadata: {
+      ...(config.environment !== undefined && {
+        environment: config.environment,
+      }),
+    },
   }
 }

package/src/utils/schema-converter.ts

@@ -1,9 +1,57 @@
+/**
+ * String `format` values accepted by OpenAI's strict Structured Outputs subset.
+ * Any other format (e.g. "uri", "uri-reference", "regex") causes the API to
+ * reject the whole request with `400 ... '<format>' is not a valid format`.
+ * MCP servers and hand-written tools routinely declare such formats, so we strip
+ * the unsupported ones before sending. See:
+ * https://platform.openai.com/docs/guides/structured-outputs#supported-properties
+ */
+const SUPPORTED_STRING_FORMATS = new Set([
+  'date-time',
+  'time',
+  'date',
+  'duration',
+  'email',
+  'hostname',
+  'ipv4',
+  'ipv6',
+  'uuid',
+])
+
+/**
+ * Recursively drop JSON-Schema `format` keywords whose value isn't in OpenAI's
+ * strict-mode allowlist. Pure — returns a fresh tree and never mutates `node`,
+ * so the caller's original tool definition is left intact.
+ *
+ * A property *named* `format` always has a schema (object/boolean) value, never
+ * a bare string, so it is preserved and recursed into; only the `format`
+ * *keyword* (whose value is a string) is subject to removal.
+ */
+function stripUnsupportedFormats(node: any): any {
+  if (Array.isArray(node)) return node.map(stripUnsupportedFormats)
+  if (node === null || typeof node !== 'object') return node
+
+  const out: Record<string, any> = {}
+  for (const [key, value] of Object.entries(node)) {
+    if (
+      key === 'format' &&
+      typeof value === 'string' &&
+      !SUPPORTED_STRING_FORMATS.has(value)
+    ) {
+      continue
+    }
+    out[key] = stripUnsupportedFormats(value)
+  }
+  return out
+}
+
 /**
  * Transform a JSON schema to be compatible with OpenAI's structured output requirements.
  * OpenAI requires:
  * - All properties must be in the `required` array
  * - Optional fields should have null added to their type union
  * - additionalProperties must be false for objects
+ * - String `format` keywords must be from a fixed allowlist (others are stripped)
  *
  * @param schema - JSON schema to transform
  * @param originalRequired - Original required array (to know which fields were optional)
@@ -12,6 +60,18 @@
 export function makeStructuredOutputCompatible(
   schema: Record<string, any>,
   originalRequired?: Array<string>,
+): Record<string, any> {
+  return stripUnsupportedFormats(coerceStrictSchema(schema, originalRequired))
+}
+
+/**
+ * Strict-mode structural rewrite (required widening, nullability,
+ * additionalProperties). Kept private so the public entry point can apply the
+ * format-stripping pass exactly once over the fully-rewritten tree.
+ */
+function coerceStrictSchema(
+  schema: Record<string, any>,
+  originalRequired?: Array<string>,
 ): Record<string, any> {
   const result = { ...schema }
   const required =
@@ -28,17 +88,14 @@ export function makeStructuredOutputCompatible(
 
       // Step 1: Recurse into nested structures
       if (prop.type === 'object' && prop.properties) {
-        prop = makeStructuredOutputCompatible(prop, prop.required || [])
+        prop = coerceStrictSchema(prop, prop.required || [])
       } else if (prop.type === 'array' && prop.items) {
         prop = {
           ...prop,
-          items: makeStructuredOutputCompatible(
-            prop.items,
-            prop.items.required || [],
-          ),
+          items: coerceStrictSchema(prop.items, prop.items.required || []),
         }
       } else if (prop.anyOf) {
-        prop = makeStructuredOutputCompatible(prop, prop.required || [])
+        prop = coerceStrictSchema(prop, prop.required || [])
       } else if (prop.oneOf) {
         throw new Error(
           'oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types',
@@ -68,15 +125,12 @@ export function makeStructuredOutputCompatible(
   }
 
   if (result.type === 'array' && result.items) {
-    result.items = makeStructuredOutputCompatible(
-      result.items,
-      result.items.required || [],
-    )
+    result.items = coerceStrictSchema(result.items, result.items.required || [])
   }
 
   if (result.anyOf && Array.isArray(result.anyOf)) {
     result.anyOf = result.anyOf.map((variant) =>
-      makeStructuredOutputCompatible(variant, variant.required || []),
+      coerceStrictSchema(variant, variant.required || []),
     )
   }