@tanstack/openai-base 0.7.0 → 0.8.0

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/openai-base",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Shared OpenAI SDK base adapters for TanStack AI providers using Chat Completions and Responses APIs.",
   "author": "",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "structured-outputs"
   ],
   "dependencies": {
-    "openai": "^6.9.1",
+    "openai": "^6.41.0",
     "@tanstack/ai-utils": "0.2.1"
   },
   "peerDependencies": {

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,
+      }),
+    },
   }
 }