@tanstack/openai-base 0.2.0 → 0.3.0

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

@@ -1,6 +1,7 @@
-import { default as OpenAI } from 'openai';
+import { Tool as SDKTool } from 'openai/resources/responses/responses';
 import { Tool } from '@tanstack/ai';
-export type LocalShellToolConfig = OpenAI.Responses.Tool.LocalShell;
+type LocalShellToolConfig = SDKTool.LocalShell;
+export type { LocalShellToolConfig };
 /** @deprecated Renamed to `LocalShellToolConfig`. Will be removed in a future release. */
 export type LocalShellTool = LocalShellToolConfig;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"local-shell-tool.js","sources":["../../../src/tools/local-shell-tool.ts"],"sourcesContent":["import type OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type LocalShellToolConfig = OpenAI.Responses.Tool.LocalShell\n\n/** @deprecated Renamed to `LocalShellToolConfig`. Will be removed in a future release. */\nexport type LocalShellTool = LocalShellToolConfig\n\n/**\n * Converts a standard Tool to OpenAI LocalShellTool format\n */\nexport function convertLocalShellToolToAdapterFormat(\n  _tool: Tool,\n): LocalShellToolConfig {\n  return {\n    type: 'local_shell',\n  }\n}\n\n/**\n * Creates a standard Tool from LocalShellTool 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 localShellTool(): Tool {\n  return {\n    name: 'local_shell',\n    description: 'Execute local shell commands',\n    metadata: {},\n  }\n}\n"],"names":[],"mappings":"AAWO,SAAS,qCACd,OACsB;AACtB,SAAO;AAAA,IACL,MAAM;AAAA,EAAA;AAEV;AAQO,SAAS,iBAAuB;AACrC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU,CAAA;AAAA,EAAC;AAEf;"}
+{"version":3,"file":"local-shell-tool.js","sources":["../../../src/tools/local-shell-tool.ts"],"sourcesContent":["import type { Tool as SDKTool } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\ntype LocalShellToolConfig = SDKTool.LocalShell\n\nexport type { LocalShellToolConfig }\n\n/** @deprecated Renamed to `LocalShellToolConfig`. Will be removed in a future release. */\nexport type LocalShellTool = LocalShellToolConfig\n\n/**\n * Converts a standard Tool to OpenAI LocalShellTool format\n */\nexport function convertLocalShellToolToAdapterFormat(\n  _tool: Tool,\n): LocalShellToolConfig {\n  return {\n    type: 'local_shell',\n  }\n}\n\n/**\n * Creates a standard Tool from LocalShellTool 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 localShellTool(): Tool {\n  return {\n    name: 'local_shell',\n    description: 'Execute local shell commands',\n    metadata: {},\n  }\n}\n"],"names":[],"mappings":"AAaO,SAAS,qCACd,OACsB;AACtB,SAAO;AAAA,IACL,MAAM;AAAA,EAAA;AAEV;AAQO,SAAS,iBAAuB;AACrC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU,CAAA;AAAA,EAAC;AAEf;"}

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

@@ -1,6 +1,7 @@
-import { default as OpenAI } from 'openai';
+import { Tool as SDKTool } from 'openai/resources/responses/responses';
 import { Tool } from '@tanstack/ai';
-export type MCPToolConfig = OpenAI.Responses.Tool.Mcp;
+type MCPToolConfig = SDKTool.Mcp;
+export type { MCPToolConfig };
 /** @deprecated Renamed to `MCPToolConfig`. Will be removed in a future release. */
 export type MCPTool = MCPToolConfig;
 export declare function validateMCPtool(tool: MCPToolConfig): void;

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

@@ -1 +1 @@
-{"version":3,"file":"mcp-tool.js","sources":["../../../src/tools/mcp-tool.ts"],"sourcesContent":["import type OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type MCPToolConfig = OpenAI.Responses.Tool.Mcp\n\n/** @deprecated Renamed to `MCPToolConfig`. Will be removed in a future release. */\nexport type MCPTool = MCPToolConfig\n\nexport function validateMCPtool(tool: MCPToolConfig) {\n  if (!tool.server_url && !tool.connector_id) {\n    throw new Error('Either server_url or connector_id must be provided.')\n  }\n  if (tool.connector_id && tool.server_url) {\n    throw new Error('Only one of server_url or connector_id can be provided.')\n  }\n}\n\n/**\n * Converts a standard Tool to OpenAI MCPTool format\n */\nexport function convertMCPToolToAdapterFormat(tool: Tool): MCPToolConfig {\n  const metadata = tool.metadata as Omit<MCPToolConfig, 'type'>\n\n  const mcpTool: MCPToolConfig = {\n    ...metadata,\n    type: 'mcp',\n  }\n\n  validateMCPtool(mcpTool)\n  return mcpTool\n}\n\n/**\n * Creates a standard Tool from MCPTool 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 mcpTool(toolData: Omit<MCPToolConfig, 'type'>): Tool {\n  validateMCPtool({ ...toolData, type: 'mcp' })\n\n  return {\n    name: 'mcp',\n    description: toolData.server_description || '',\n    metadata: toolData,\n  }\n}\n"],"names":["mcpTool"],"mappings":"AAQO,SAAS,gBAAgB,MAAqB;AACnD,MAAI,CAAC,KAAK,cAAc,CAAC,KAAK,cAAc;AAC1C,UAAM,IAAI,MAAM,qDAAqD;AAAA,EACvE;AACA,MAAI,KAAK,gBAAgB,KAAK,YAAY;AACxC,UAAM,IAAI,MAAM,yDAAyD;AAAA,EAC3E;AACF;AAKO,SAAS,8BAA8B,MAA2B;AACvE,QAAM,WAAW,KAAK;AAEtB,QAAMA,WAAyB;AAAA,IAC7B,GAAG;AAAA,IACH,MAAM;AAAA,EAAA;AAGR,kBAAgBA,QAAO;AACvB,SAAOA;AACT;AAQO,SAAS,QAAQ,UAA6C;AACnE,kBAAgB,EAAE,GAAG,SAAsB,CAAC;AAE5C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa,SAAS,sBAAsB;AAAA,IAC5C,UAAU;AAAA,EAAA;AAEd;"}
+{"version":3,"file":"mcp-tool.js","sources":["../../../src/tools/mcp-tool.ts"],"sourcesContent":["import type { Tool as SDKTool } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\ntype MCPToolConfig = SDKTool.Mcp\n\nexport type { MCPToolConfig }\n\n/** @deprecated Renamed to `MCPToolConfig`. Will be removed in a future release. */\nexport type MCPTool = MCPToolConfig\n\nexport function validateMCPtool(tool: MCPToolConfig) {\n  if (!tool.server_url && !tool.connector_id) {\n    throw new Error('Either server_url or connector_id must be provided.')\n  }\n  if (tool.connector_id && tool.server_url) {\n    throw new Error('Only one of server_url or connector_id can be provided.')\n  }\n}\n\n/**\n * Converts a standard Tool to OpenAI MCPTool format\n */\nexport function convertMCPToolToAdapterFormat(tool: Tool): MCPToolConfig {\n  const metadata = tool.metadata as Omit<MCPToolConfig, 'type'>\n\n  const mcpTool: MCPToolConfig = {\n    ...metadata,\n    type: 'mcp',\n  }\n\n  validateMCPtool(mcpTool)\n  return mcpTool\n}\n\n/**\n * Creates a standard Tool from MCPTool 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 mcpTool(toolData: Omit<MCPToolConfig, 'type'>): Tool {\n  validateMCPtool({ ...toolData, type: 'mcp' })\n\n  return {\n    name: 'mcp',\n    description: toolData.server_description || '',\n    metadata: toolData,\n  }\n}\n"],"names":["mcpTool"],"mappings":"AAUO,SAAS,gBAAgB,MAAqB;AACnD,MAAI,CAAC,KAAK,cAAc,CAAC,KAAK,cAAc;AAC1C,UAAM,IAAI,MAAM,qDAAqD;AAAA,EACvE;AACA,MAAI,KAAK,gBAAgB,KAAK,YAAY;AACxC,UAAM,IAAI,MAAM,yDAAyD;AAAA,EAC3E;AACF;AAKO,SAAS,8BAA8B,MAA2B;AACvE,QAAM,WAAW,KAAK;AAEtB,QAAMA,WAAyB;AAAA,IAC7B,GAAG;AAAA,IACH,MAAM;AAAA,EAAA;AAGR,kBAAgBA,QAAO;AACvB,SAAOA;AACT;AAQO,SAAS,QAAQ,UAA6C;AACnE,kBAAgB,EAAE,GAAG,SAAsB,CAAC;AAE5C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa,SAAS,sBAAsB;AAAA,IAC5C,UAAU;AAAA,EAAA;AAEd;"}

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

@@ -1,6 +1,6 @@
-import { default as OpenAI } from 'openai';
+import { FunctionShellTool as ShellToolConfig } from 'openai/resources/responses/responses';
 import { Tool } from '@tanstack/ai';
-export type ShellToolConfig = OpenAI.Responses.FunctionShellTool;
+export type { ShellToolConfig };
 /** @deprecated Renamed to `ShellToolConfig`. Will be removed in a future release. */
 export type ShellTool = ShellToolConfig;
 /**

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 OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type ShellToolConfig = OpenAI.Responses.FunctionShellTool\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 * 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;"}

package/dist/esm/tools/web-search-preview-tool.d.ts

@@ -1,6 +1,6 @@
-import { default as OpenAI } from 'openai';
+import { WebSearchPreviewTool as WebSearchPreviewToolConfig } from 'openai/resources/responses/responses';
 import { Tool } from '@tanstack/ai';
-export type WebSearchPreviewToolConfig = OpenAI.Responses.WebSearchPreviewTool;
+export type { WebSearchPreviewToolConfig };
 /** @deprecated Renamed to `WebSearchPreviewToolConfig`. Will be removed in a future release. */
 export type WebSearchPreviewTool = WebSearchPreviewToolConfig;
 /**

package/dist/esm/tools/web-search-preview-tool.js.map

@@ -1 +1 @@
-{"version":3,"file":"web-search-preview-tool.js","sources":["../../../src/tools/web-search-preview-tool.ts"],"sourcesContent":["import type OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type WebSearchPreviewToolConfig = OpenAI.Responses.WebSearchPreviewTool\n\n/** @deprecated Renamed to `WebSearchPreviewToolConfig`. Will be removed in a future release. */\nexport type WebSearchPreviewTool = WebSearchPreviewToolConfig\n\n/**\n * Converts a standard Tool to OpenAI WebSearchPreviewTool format. Force the\n * literal `type: 'web_search_preview'` instead of trusting `metadata.type`,\n * since a hand-authored tool with a missing or wrong `type` would emit a\n * malformed payload while the dispatcher already routed by `tool.name`.\n */\nexport function convertWebSearchPreviewToolToAdapterFormat(\n  tool: Tool,\n): WebSearchPreviewToolConfig {\n  const metadata = tool.metadata as Omit<WebSearchPreviewToolConfig, 'type'>\n  return {\n    ...metadata,\n    type: 'web_search_preview',\n  }\n}\n\n/**\n * Creates a standard Tool from WebSearchPreviewTool 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 webSearchPreviewTool(\n  toolData: WebSearchPreviewToolConfig,\n): Tool {\n  return {\n    name: 'web_search_preview',\n    description: 'Search the web (preview version)',\n    metadata: toolData,\n  }\n}\n"],"names":[],"mappings":"AAcO,SAAS,2CACd,MAC4B;AAC5B,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,GAAG;AAAA,IACH,MAAM;AAAA,EAAA;AAEV;AAQO,SAAS,qBACd,UACM;AACN,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,EAAA;AAEd;"}
+{"version":3,"file":"web-search-preview-tool.js","sources":["../../../src/tools/web-search-preview-tool.ts"],"sourcesContent":["import type { WebSearchPreviewTool as WebSearchPreviewToolConfig } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\nexport type { WebSearchPreviewToolConfig }\n\n/** @deprecated Renamed to `WebSearchPreviewToolConfig`. Will be removed in a future release. */\nexport type WebSearchPreviewTool = WebSearchPreviewToolConfig\n\n/**\n * Converts a standard Tool to OpenAI WebSearchPreviewTool format. Force the\n * literal `type: 'web_search_preview'` instead of trusting `metadata.type`,\n * since a hand-authored tool with a missing or wrong `type` would emit a\n * malformed payload while the dispatcher already routed by `tool.name`.\n */\nexport function convertWebSearchPreviewToolToAdapterFormat(\n  tool: Tool,\n): WebSearchPreviewToolConfig {\n  const metadata = tool.metadata as Omit<WebSearchPreviewToolConfig, 'type'>\n  return {\n    ...metadata,\n    type: 'web_search_preview',\n  }\n}\n\n/**\n * Creates a standard Tool from WebSearchPreviewTool 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 webSearchPreviewTool(\n  toolData: WebSearchPreviewToolConfig,\n): Tool {\n  return {\n    name: 'web_search_preview',\n    description: 'Search the web (preview version)',\n    metadata: toolData,\n  }\n}\n"],"names":[],"mappings":"AAcO,SAAS,2CACd,MAC4B;AAC5B,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,GAAG;AAAA,IACH,MAAM;AAAA,EAAA;AAEV;AAQO,SAAS,qBACd,UACM;AACN,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,EAAA;AAEd;"}

package/dist/esm/tools/web-search-tool.d.ts

@@ -1,6 +1,6 @@
-import { default as OpenAI } from 'openai';
+import { WebSearchTool as WebSearchToolConfig } from 'openai/resources/responses/responses';
 import { Tool } from '@tanstack/ai';
-export type WebSearchToolConfig = OpenAI.Responses.WebSearchTool;
+export type { WebSearchToolConfig };
 /** @deprecated Renamed to `WebSearchToolConfig`. Will be removed in a future release. */
 export type WebSearchTool = WebSearchToolConfig;
 /**

package/dist/esm/tools/web-search-tool.js.map

@@ -1 +1 @@
-{"version":3,"file":"web-search-tool.js","sources":["../../../src/tools/web-search-tool.ts"],"sourcesContent":["import type OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type WebSearchToolConfig = OpenAI.Responses.WebSearchTool\n\n/** @deprecated Renamed to `WebSearchToolConfig`. Will be removed in a future release. */\nexport type WebSearchTool = WebSearchToolConfig\n\n/**\n * Converts a standard Tool to OpenAI WebSearchTool format. Spread `metadata`\n * first, then force `type: 'web_search'` last to keep the runtime `type`\n * matching the discriminator the dispatcher routed by — otherwise a tool\n * authored by hand with a different `metadata.type` would emit a malformed\n * payload.\n */\nexport function convertWebSearchToolToAdapterFormat(\n  tool: Tool,\n): WebSearchToolConfig {\n  const metadata = tool.metadata as Omit<WebSearchToolConfig, 'type'>\n  return {\n    ...metadata,\n    type: 'web_search',\n  }\n}\n\n/**\n * Creates a standard Tool from WebSearchTool 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 webSearchTool(toolData: WebSearchToolConfig): Tool {\n  return {\n    name: 'web_search',\n    description: 'Search the web',\n    metadata: toolData,\n  }\n}\n"],"names":[],"mappings":"AAeO,SAAS,oCACd,MACqB;AACrB,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,GAAG;AAAA,IACH,MAAM;AAAA,EAAA;AAEV;AAQO,SAAS,cAAc,UAAqC;AACjE,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,EAAA;AAEd;"}
+{"version":3,"file":"web-search-tool.js","sources":["../../../src/tools/web-search-tool.ts"],"sourcesContent":["import type { WebSearchTool as WebSearchToolConfig } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\nexport type { WebSearchToolConfig }\n\n/** @deprecated Renamed to `WebSearchToolConfig`. Will be removed in a future release. */\nexport type WebSearchTool = WebSearchToolConfig\n\n/**\n * Converts a standard Tool to OpenAI WebSearchTool format. Spread `metadata`\n * first, then force `type: 'web_search'` last to keep the runtime `type`\n * matching the discriminator the dispatcher routed by — otherwise a tool\n * authored by hand with a different `metadata.type` would emit a malformed\n * payload.\n */\nexport function convertWebSearchToolToAdapterFormat(\n  tool: Tool,\n): WebSearchToolConfig {\n  const metadata = tool.metadata as Omit<WebSearchToolConfig, 'type'>\n  return {\n    ...metadata,\n    type: 'web_search',\n  }\n}\n\n/**\n * Creates a standard Tool from WebSearchTool 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 webSearchTool(toolData: WebSearchToolConfig): Tool {\n  return {\n    name: 'web_search',\n    description: 'Search the web',\n    metadata: toolData,\n  }\n}\n"],"names":[],"mappings":"AAeO,SAAS,oCACd,MACqB;AACrB,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,GAAG;AAAA,IACH,MAAM;AAAA,EAAA;AAEV;AAQO,SAAS,cAAc,UAAqC;AACjE,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,EAAA;AAEd;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/openai-base",
-  "version": "0.2.0",
-  "description": "Shared base adapters and utilities for OpenAI-compatible providers in TanStack AI",
+  "version": "0.3.0",
+  "description": "Shared base adapters for OpenAI-SDK-backed providers in TanStack AI (Chat Completions and Responses)",
   "author": "",
   "license": "MIT",
   "repository": {
@@ -26,20 +26,20 @@
     "ai",
     "openai",
     "tanstack",
-    "adapter",
-    "base"
+    "adapter"
   ],
   "dependencies": {
     "openai": "^6.9.1",
     "@tanstack/ai-utils": "0.2.0"
   },
   "peerDependencies": {
-    "@tanstack/ai": "^0.15.0"
+    "@tanstack/ai": "^0.17.0"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "4.0.14",
     "vite": "^7.2.7",
-    "@tanstack/ai": "0.15.0"
+    "zod": "^4.2.0",
+    "@tanstack/ai": "0.17.0"
   },
   "scripts": {
     "build": "vite build",