@tanstack/openai-base 0.1.0 → 0.2.1

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

@@ -1,6 +1,8 @@
 import { Tool } from '@tanstack/ai';
 import { default as OpenAI } from 'openai';
-export type FunctionTool = OpenAI.Responses.FunctionTool;
+export type FunctionToolConfig = OpenAI.Responses.FunctionTool;
+/** @deprecated Renamed to `FunctionToolConfig`. Will be removed in a future release. */
+export type FunctionTool = FunctionToolConfig;
 /**
  * Converts a standard Tool to OpenAI FunctionTool format.
  *
@@ -12,4 +14,4 @@ export type FunctionTool = OpenAI.Responses.FunctionTool;
  *
  * This enables strict mode for all tools automatically.
  */
-export declare function convertFunctionToolToAdapterFormat(tool: Tool): FunctionTool;
+export declare function convertFunctionToolToAdapterFormat(tool: Tool): FunctionToolConfig;

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

@@ -1 +1 @@
-{"version":3,"file":"function-tool.js","sources":["../../../src/tools/function-tool.ts"],"sourcesContent":["import { makeStructuredOutputCompatible } from '../utils/schema-converter'\nimport type { JSONSchema, Tool } from '@tanstack/ai'\nimport type OpenAI from 'openai'\n\nexport type FunctionTool = OpenAI.Responses.FunctionTool\n\n/**\n * Converts a standard Tool to OpenAI FunctionTool format.\n *\n * Tool schemas are already converted to JSON Schema in the ai layer.\n * We apply OpenAI-specific transformations for strict mode:\n * - All properties in required array\n * - Optional fields made nullable\n * - additionalProperties: false\n *\n * This enables strict mode for all tools automatically.\n */\nexport function convertFunctionToolToAdapterFormat(tool: Tool): FunctionTool {\n  const inputSchema = (tool.inputSchema ?? {\n    type: 'object',\n    properties: {},\n    required: [],\n  }) as JSONSchema\n\n  const jsonSchema = makeStructuredOutputCompatible(\n    inputSchema,\n    inputSchema.required || [],\n  )\n\n  jsonSchema.additionalProperties = false\n\n  return {\n    type: 'function',\n    name: tool.name,\n    description: tool.description,\n    parameters: jsonSchema,\n    strict: true,\n  } satisfies FunctionTool\n}\n"],"names":[],"mappings":";AAiBO,SAAS,mCAAmC,MAA0B;AAC3E,QAAM,cAAe,KAAK,eAAe;AAAA,IACvC,MAAM;AAAA,IACN,YAAY,CAAA;AAAA,IACZ,UAAU,CAAA;AAAA,EAAC;AAGb,QAAM,aAAa;AAAA,IACjB;AAAA,IACA,YAAY,YAAY,CAAA;AAAA,EAAC;AAG3B,aAAW,uBAAuB;AAElC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,MAAM,KAAK;AAAA,IACX,aAAa,KAAK;AAAA,IAClB,YAAY;AAAA,IACZ,QAAQ;AAAA,EAAA;AAEZ;"}
+{"version":3,"file":"function-tool.js","sources":["../../../src/tools/function-tool.ts"],"sourcesContent":["import { makeStructuredOutputCompatible } from '../utils/schema-converter'\nimport type { JSONSchema, Tool } from '@tanstack/ai'\nimport type OpenAI from 'openai'\n\nexport type FunctionToolConfig = OpenAI.Responses.FunctionTool\n\n/** @deprecated Renamed to `FunctionToolConfig`. Will be removed in a future release. */\nexport type FunctionTool = FunctionToolConfig\n\n/**\n * Converts a standard Tool to OpenAI FunctionTool format.\n *\n * Tool schemas are already converted to JSON Schema in the ai layer.\n * We apply OpenAI-specific transformations for strict mode:\n * - All properties in required array\n * - Optional fields made nullable\n * - additionalProperties: false\n *\n * This enables strict mode for all tools automatically.\n */\nexport function convertFunctionToolToAdapterFormat(\n  tool: Tool,\n): FunctionToolConfig {\n  const inputSchema = (tool.inputSchema ?? {\n    type: 'object',\n    properties: {},\n    required: [],\n  }) as JSONSchema\n\n  const jsonSchema = makeStructuredOutputCompatible(\n    inputSchema,\n    inputSchema.required || [],\n  )\n\n  jsonSchema.additionalProperties = false\n\n  return {\n    type: 'function',\n    name: tool.name,\n    description: tool.description,\n    parameters: jsonSchema,\n    strict: true,\n  } satisfies FunctionToolConfig\n}\n"],"names":[],"mappings":";AAoBO,SAAS,mCACd,MACoB;AACpB,QAAM,cAAe,KAAK,eAAe;AAAA,IACvC,MAAM;AAAA,IACN,YAAY,CAAA;AAAA,IACZ,UAAU,CAAA;AAAA,EAAC;AAGb,QAAM,aAAa;AAAA,IACjB;AAAA,IACA,YAAY,YAAY,CAAA;AAAA,EAAC;AAG3B,aAAW,uBAAuB;AAElC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,MAAM,KAAK;AAAA,IACX,aAAa,KAAK;AAAA,IAClB,YAAY;AAAA,IACZ,QAAQ;AAAA,EAAA;AAEZ;"}

package/dist/esm/tools/image-generation-tool.d.ts

@@ -1,11 +1,22 @@
 import { default as OpenAI } from 'openai';
 import { Tool } from '@tanstack/ai';
-export type ImageGenerationTool = OpenAI.Responses.Tool.ImageGeneration;
+export type ImageGenerationToolConfig = OpenAI.Responses.Tool.ImageGeneration;
+/** @deprecated Renamed to `ImageGenerationToolConfig`. Will be removed in a future release. */
+export type ImageGenerationTool = ImageGenerationToolConfig;
+declare const validatePartialImages: (value: number | undefined) => void;
 /**
- * Converts a standard Tool to OpenAI ImageGenerationTool format
+ * Converts a standard Tool to OpenAI ImageGenerationTool format. Spread
+ * `metadata` first, then force `type: 'image_generation'` last — otherwise a
+ * `metadata.type` snuck in by a hand-built tool would shadow the literal and
+ * the dispatcher (which routed by `tool.name`) would emit a tool whose
+ * runtime `type` doesn't match `image_generation`.
  */
-export declare function convertImageGenerationToolToAdapterFormat(tool: Tool): ImageGenerationTool;
+export declare function convertImageGenerationToolToAdapterFormat(tool: Tool): ImageGenerationToolConfig;
 /**
- * Creates a standard Tool from ImageGenerationTool parameters
+ * Creates a standard Tool from ImageGenerationTool parameters.
+ *
+ * Base (non-branded) factory. Providers that need branded return types should
+ * re-wrap this in their own package.
  */
-export declare function imageGenerationTool(toolData: Omit<ImageGenerationTool, 'type'>): Tool;
+export declare function imageGenerationTool(toolData: Omit<ImageGenerationToolConfig, 'type'>): Tool;
+export { validatePartialImages };

package/dist/esm/tools/image-generation-tool.js

@@ -6,8 +6,8 @@ const validatePartialImages = (value) => {
 function convertImageGenerationToolToAdapterFormat(tool) {
   const metadata = tool.metadata;
   return {
-    type: "image_generation",
-    ...metadata
+    ...metadata,
+    type: "image_generation"
   };
 }
 function imageGenerationTool(toolData) {
@@ -22,6 +22,7 @@ function imageGenerationTool(toolData) {
 }
 export {
   convertImageGenerationToolToAdapterFormat,
-  imageGenerationTool
+  imageGenerationTool,
+  validatePartialImages
 };
 //# sourceMappingURL=image-generation-tool.js.map

package/dist/esm/tools/image-generation-tool.js.map

@@ -1 +1 @@
-{"version":3,"file":"image-generation-tool.js","sources":["../../../src/tools/image-generation-tool.ts"],"sourcesContent":["import type OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type ImageGenerationTool = OpenAI.Responses.Tool.ImageGeneration\n\nconst validatePartialImages = (value: number | undefined) => {\n  if (value !== undefined && (value < 0 || value > 3)) {\n    throw new Error('partial_images must be between 0 and 3')\n  }\n}\n\n/**\n * Converts a standard Tool to OpenAI ImageGenerationTool format\n */\nexport function convertImageGenerationToolToAdapterFormat(\n  tool: Tool,\n): ImageGenerationTool {\n  const metadata = tool.metadata as Omit<ImageGenerationTool, 'type'>\n  return {\n    type: 'image_generation',\n    ...metadata,\n  }\n}\n\n/**\n * Creates a standard Tool from ImageGenerationTool parameters\n */\nexport function imageGenerationTool(\n  toolData: Omit<ImageGenerationTool, 'type'>,\n): Tool {\n  validatePartialImages(toolData.partial_images)\n  return {\n    name: 'image_generation',\n    description: 'Generate images based on text descriptions',\n    metadata: {\n      ...toolData,\n    },\n  }\n}\n"],"names":[],"mappings":"AAKA,MAAM,wBAAwB,CAAC,UAA8B;AAC3D,MAAI,UAAU,WAAc,QAAQ,KAAK,QAAQ,IAAI;AACnD,UAAM,IAAI,MAAM,wCAAwC;AAAA,EAC1D;AACF;AAKO,SAAS,0CACd,MACqB;AACrB,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,MAAM;AAAA,IACN,GAAG;AAAA,EAAA;AAEP;AAKO,SAAS,oBACd,UACM;AACN,wBAAsB,SAAS,cAAc;AAC7C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,MACR,GAAG;AAAA,IAAA;AAAA,EACL;AAEJ;"}
+{"version":3,"file":"image-generation-tool.js","sources":["../../../src/tools/image-generation-tool.ts"],"sourcesContent":["import type OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type ImageGenerationToolConfig = OpenAI.Responses.Tool.ImageGeneration\n\n/** @deprecated Renamed to `ImageGenerationToolConfig`. Will be removed in a future release. */\nexport type ImageGenerationTool = ImageGenerationToolConfig\n\nconst validatePartialImages = (value: number | undefined) => {\n  if (value !== undefined && (value < 0 || value > 3)) {\n    throw new Error('partial_images must be between 0 and 3')\n  }\n}\n\n/**\n * Converts a standard Tool to OpenAI ImageGenerationTool format. Spread\n * `metadata` first, then force `type: 'image_generation'` last — otherwise a\n * `metadata.type` snuck in by a hand-built tool would shadow the literal and\n * the dispatcher (which routed by `tool.name`) would emit a tool whose\n * runtime `type` doesn't match `image_generation`.\n */\nexport function convertImageGenerationToolToAdapterFormat(\n  tool: Tool,\n): ImageGenerationToolConfig {\n  const metadata = tool.metadata as Omit<ImageGenerationToolConfig, 'type'>\n  return {\n    ...metadata,\n    type: 'image_generation',\n  }\n}\n\n/**\n * Creates a standard Tool from ImageGenerationTool 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 imageGenerationTool(\n  toolData: Omit<ImageGenerationToolConfig, 'type'>,\n): Tool {\n  validatePartialImages(toolData.partial_images)\n  return {\n    name: 'image_generation',\n    description: 'Generate images based on text descriptions',\n    metadata: {\n      ...toolData,\n    },\n  }\n}\n\nexport { validatePartialImages }\n"],"names":[],"mappings":"AAQA,MAAM,wBAAwB,CAAC,UAA8B;AAC3D,MAAI,UAAU,WAAc,QAAQ,KAAK,QAAQ,IAAI;AACnD,UAAM,IAAI,MAAM,wCAAwC;AAAA,EAC1D;AACF;AASO,SAAS,0CACd,MAC2B;AAC3B,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,GAAG;AAAA,IACH,MAAM;AAAA,EAAA;AAEV;AAQO,SAAS,oBACd,UACM;AACN,wBAAsB,SAAS,cAAc;AAC7C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,MACR,GAAG;AAAA,IAAA;AAAA,EACL;AAEJ;"}

package/dist/esm/tools/index.d.ts

@@ -1,16 +1,16 @@
-import { ApplyPatchTool } from './apply-patch-tool.js';
-import { CodeInterpreterTool } from './code-interpreter-tool.js';
-import { ComputerUseTool } from './computer-use-tool.js';
-import { CustomTool } from './custom-tool.js';
-import { FileSearchTool } from './file-search-tool.js';
-import { FunctionTool } from './function-tool.js';
-import { ImageGenerationTool } from './image-generation-tool.js';
-import { LocalShellTool } from './local-shell-tool.js';
-import { MCPTool } from './mcp-tool.js';
-import { ShellTool } from './shell-tool.js';
-import { WebSearchPreviewTool } from './web-search-preview-tool.js';
-import { WebSearchTool } from './web-search-tool.js';
-export type OpenAITool = ApplyPatchTool | CodeInterpreterTool | ComputerUseTool | CustomTool | FileSearchTool | FunctionTool | ImageGenerationTool | LocalShellTool | MCPTool | ShellTool | WebSearchPreviewTool | WebSearchTool;
+import { ApplyPatchToolConfig } from './apply-patch-tool.js';
+import { CodeInterpreterToolConfig } from './code-interpreter-tool.js';
+import { ComputerUseToolConfig } from './computer-use-tool.js';
+import { CustomToolConfig } from './custom-tool.js';
+import { FileSearchToolConfig } from './file-search-tool.js';
+import { FunctionToolConfig } from './function-tool.js';
+import { ImageGenerationToolConfig } from './image-generation-tool.js';
+import { LocalShellToolConfig } from './local-shell-tool.js';
+import { MCPToolConfig } from './mcp-tool.js';
+import { ShellToolConfig } from './shell-tool.js';
+import { WebSearchPreviewToolConfig } from './web-search-preview-tool.js';
+import { WebSearchToolConfig } from './web-search-tool.js';
+export type OpenAITool = ApplyPatchToolConfig | CodeInterpreterToolConfig | ComputerUseToolConfig | CustomToolConfig | FileSearchToolConfig | FunctionToolConfig | ImageGenerationToolConfig | LocalShellToolConfig | MCPToolConfig | ShellToolConfig | WebSearchPreviewToolConfig | WebSearchToolConfig;
 export * from './apply-patch-tool.js';
 export * from './code-interpreter-tool.js';
 export * from './computer-use-tool.js';

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

@@ -1,11 +1,16 @@
 import { default as OpenAI } from 'openai';
 import { Tool } from '@tanstack/ai';
-export type LocalShellTool = OpenAI.Responses.Tool.LocalShell;
+export type LocalShellToolConfig = OpenAI.Responses.Tool.LocalShell;
+/** @deprecated Renamed to `LocalShellToolConfig`. Will be removed in a future release. */
+export type LocalShellTool = LocalShellToolConfig;
 /**
  * Converts a standard Tool to OpenAI LocalShellTool format
  */
-export declare function convertLocalShellToolToAdapterFormat(_tool: Tool): LocalShellTool;
+export declare function convertLocalShellToolToAdapterFormat(_tool: Tool): LocalShellToolConfig;
 /**
- * Creates a standard Tool from LocalShellTool parameters
+ * Creates a standard Tool from LocalShellTool parameters.
+ *
+ * Base (non-branded) factory. Providers that need branded return types should
+ * re-wrap this in their own package.
  */
 export declare function localShellTool(): Tool;

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 LocalShellTool = OpenAI.Responses.Tool.LocalShell\n\n/**\n * Converts a standard Tool to OpenAI LocalShellTool format\n */\nexport function convertLocalShellToolToAdapterFormat(\n  _tool: Tool,\n): LocalShellTool {\n  return {\n    type: 'local_shell',\n  }\n}\n\n/**\n * Creates a standard Tool from LocalShellTool parameters\n */\nexport function localShellTool(): Tool {\n  return {\n    name: 'local_shell',\n    description: 'Execute local shell commands',\n    metadata: {},\n  }\n}\n"],"names":[],"mappings":"AAQO,SAAS,qCACd,OACgB;AAChB,SAAO;AAAA,IACL,MAAM;AAAA,EAAA;AAEV;AAKO,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 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;"}

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

@@ -1,12 +1,17 @@
 import { default as OpenAI } from 'openai';
 import { Tool } from '@tanstack/ai';
-export type MCPTool = OpenAI.Responses.Tool.Mcp;
-export declare function validateMCPtool(tool: MCPTool): void;
+export type MCPToolConfig = OpenAI.Responses.Tool.Mcp;
+/** @deprecated Renamed to `MCPToolConfig`. Will be removed in a future release. */
+export type MCPTool = MCPToolConfig;
+export declare function validateMCPtool(tool: MCPToolConfig): void;
 /**
  * Converts a standard Tool to OpenAI MCPTool format
  */
-export declare function convertMCPToolToAdapterFormat(tool: Tool): MCPTool;
+export declare function convertMCPToolToAdapterFormat(tool: Tool): MCPToolConfig;
 /**
- * Creates a standard Tool from MCPTool parameters
+ * Creates a standard Tool from MCPTool parameters.
+ *
+ * Base (non-branded) factory. Providers that need branded return types should
+ * re-wrap this in their own package.
  */
-export declare function mcpTool(toolData: Omit<MCPTool, 'type'>): Tool;
+export declare function mcpTool(toolData: Omit<MCPToolConfig, 'type'>): Tool;

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 MCPTool = OpenAI.Responses.Tool.Mcp\n\nexport function validateMCPtool(tool: MCPTool) {\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): MCPTool {\n  const metadata = tool.metadata as Omit<MCPTool, 'type'>\n\n  const mcpTool: MCPTool = {\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 */\nexport function mcpTool(toolData: Omit<MCPTool, '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":"AAKO,SAAS,gBAAgB,MAAe;AAC7C,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,MAAqB;AACjE,QAAM,WAAW,KAAK;AAEtB,QAAMA,WAAmB;AAAA,IACvB,GAAG;AAAA,IACH,MAAM;AAAA,EAAA;AAGR,kBAAgBA,QAAO;AACvB,SAAOA;AACT;AAKO,SAAS,QAAQ,UAAuC;AAC7D,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 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;"}

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

@@ -1,11 +1,16 @@
 import { default as OpenAI } from 'openai';
 import { Tool } from '@tanstack/ai';
-export type ShellTool = OpenAI.Responses.FunctionShellTool;
+export type ShellToolConfig = OpenAI.Responses.FunctionShellTool;
+/** @deprecated Renamed to `ShellToolConfig`. Will be removed in a future release. */
+export type ShellTool = ShellToolConfig;
 /**
  * Converts a standard Tool to OpenAI ShellTool format
  */
-export declare function convertShellToolToAdapterFormat(_tool: Tool): ShellTool;
+export declare function convertShellToolToAdapterFormat(_tool: Tool): ShellToolConfig;
 /**
- * Creates a standard Tool from ShellTool parameters
+ * 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;

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 ShellTool = OpenAI.Responses.FunctionShellTool\n\n/**\n * Converts a standard Tool to OpenAI ShellTool format\n */\nexport function convertShellToolToAdapterFormat(_tool: Tool): ShellTool {\n  return {\n    type: 'shell',\n  }\n}\n\n/**\n * Creates a standard Tool from ShellTool parameters\n */\nexport function shellTool(): Tool {\n  return {\n    name: 'shell',\n    description: 'Execute shell commands',\n    metadata: {},\n  }\n}\n"],"names":[],"mappings":"AAQO,SAAS,gCAAgC,OAAwB;AACtE,SAAO;AAAA,IACL,MAAM;AAAA,EAAA;AAEV;AAKO,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 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;"}

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

@@ -1,11 +1,19 @@
 import { default as OpenAI } from 'openai';
 import { Tool } from '@tanstack/ai';
-export type WebSearchPreviewTool = OpenAI.Responses.WebSearchPreviewTool;
+export type WebSearchPreviewToolConfig = OpenAI.Responses.WebSearchPreviewTool;
+/** @deprecated Renamed to `WebSearchPreviewToolConfig`. Will be removed in a future release. */
+export type WebSearchPreviewTool = WebSearchPreviewToolConfig;
 /**
- * Converts a standard Tool to OpenAI WebSearchPreviewTool format
+ * Converts a standard Tool to OpenAI WebSearchPreviewTool format. Force the
+ * literal `type: 'web_search_preview'` instead of trusting `metadata.type`,
+ * since a hand-authored tool with a missing or wrong `type` would emit a
+ * malformed payload while the dispatcher already routed by `tool.name`.
  */
-export declare function convertWebSearchPreviewToolToAdapterFormat(tool: Tool): WebSearchPreviewTool;
+export declare function convertWebSearchPreviewToolToAdapterFormat(tool: Tool): WebSearchPreviewToolConfig;
 /**
- * Creates a standard Tool from WebSearchPreviewTool parameters
+ * Creates a standard Tool from WebSearchPreviewTool parameters.
+ *
+ * Base (non-branded) factory. Providers that need branded return types should
+ * re-wrap this in their own package.
  */
-export declare function webSearchPreviewTool(toolData: WebSearchPreviewTool): Tool;
+export declare function webSearchPreviewTool(toolData: WebSearchPreviewToolConfig): Tool;

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

@@ -1,9 +1,8 @@
 function convertWebSearchPreviewToolToAdapterFormat(tool) {
   const metadata = tool.metadata;
   return {
-    type: metadata.type,
-    search_context_size: metadata.search_context_size,
-    user_location: metadata.user_location
+    ...metadata,
+    type: "web_search_preview"
   };
 }
 function webSearchPreviewTool(toolData) {

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 WebSearchPreviewTool = OpenAI.Responses.WebSearchPreviewTool\n\n/**\n * Converts a standard Tool to OpenAI WebSearchPreviewTool format\n */\nexport function convertWebSearchPreviewToolToAdapterFormat(\n  tool: Tool,\n): WebSearchPreviewTool {\n  const metadata = tool.metadata as WebSearchPreviewTool\n  return {\n    type: metadata.type,\n    search_context_size: metadata.search_context_size,\n    user_location: metadata.user_location,\n  }\n}\n\n/**\n * Creates a standard Tool from WebSearchPreviewTool parameters\n */\nexport function webSearchPreviewTool(toolData: WebSearchPreviewTool): Tool {\n  return {\n    name: 'web_search_preview',\n    description: 'Search the web (preview version)',\n    metadata: toolData,\n  }\n}\n"],"names":[],"mappings":"AAQO,SAAS,2CACd,MACsB;AACtB,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,MAAM,SAAS;AAAA,IACf,qBAAqB,SAAS;AAAA,IAC9B,eAAe,SAAS;AAAA,EAAA;AAE5B;AAKO,SAAS,qBAAqB,UAAsC;AACzE,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 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;"}

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

@@ -1,11 +1,20 @@
 import { default as OpenAI } from 'openai';
 import { Tool } from '@tanstack/ai';
-export type WebSearchTool = OpenAI.Responses.WebSearchTool;
+export type WebSearchToolConfig = OpenAI.Responses.WebSearchTool;
+/** @deprecated Renamed to `WebSearchToolConfig`. Will be removed in a future release. */
+export type WebSearchTool = WebSearchToolConfig;
 /**
- * Converts a standard Tool to OpenAI WebSearchTool format
+ * Converts a standard Tool to OpenAI WebSearchTool format. Spread `metadata`
+ * first, then force `type: 'web_search'` last to keep the runtime `type`
+ * matching the discriminator the dispatcher routed by — otherwise a tool
+ * authored by hand with a different `metadata.type` would emit a malformed
+ * payload.
  */
-export declare function convertWebSearchToolToAdapterFormat(tool: Tool): WebSearchTool;
+export declare function convertWebSearchToolToAdapterFormat(tool: Tool): WebSearchToolConfig;
 /**
- * Creates a standard Tool from WebSearchTool parameters
+ * Creates a standard Tool from WebSearchTool parameters.
+ *
+ * Base (non-branded) factory. Providers that need branded return types should
+ * re-wrap this in their own package.
  */
-export declare function webSearchTool(toolData: WebSearchTool): Tool;
+export declare function webSearchTool(toolData: WebSearchToolConfig): Tool;

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

@@ -1,6 +1,9 @@
 function convertWebSearchToolToAdapterFormat(tool) {
   const metadata = tool.metadata;
-  return metadata;
+  return {
+    ...metadata,
+    type: "web_search"
+  };
 }
 function webSearchTool(toolData) {
   return {

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 WebSearchTool = OpenAI.Responses.WebSearchTool\n\n/**\n * Converts a standard Tool to OpenAI WebSearchTool format\n */\nexport function convertWebSearchToolToAdapterFormat(tool: Tool): WebSearchTool {\n  const metadata = tool.metadata as WebSearchTool\n  return metadata\n}\n\n/**\n * Creates a standard Tool from WebSearchTool parameters\n */\nexport function webSearchTool(toolData: WebSearchTool): Tool {\n  return {\n    name: 'web_search',\n    description: 'Search the web',\n    metadata: toolData,\n  }\n}\n"],"names":[],"mappings":"AAQO,SAAS,oCAAoC,MAA2B;AAC7E,QAAM,WAAW,KAAK;AACtB,SAAO;AACT;AAKO,SAAS,cAAc,UAA+B;AAC3D,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 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;"}

package/dist/esm/utils/request-options.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Extract `headers` and `signal` from a `Request | RequestInit` for the OpenAI
+ * SDK's per-call `RequestOptions`. `Request` exposes `headers` as a `Headers`
+ * instance (HeadersInit-compatible) while `RequestInit` exposes `HeadersInit`
+ * directly — this helper accepts either shape so callers don't need to cast.
+ *
+ * Always returns an object (possibly empty) rather than `undefined` so test
+ * assertions that match the second argument shape via `expect.anything()` /
+ * `expect.objectContaining()` keep working when no request override was set.
+ */
+export declare function extractRequestOptions(request: Request | RequestInit | undefined): {
+    headers?: HeadersInit;
+    signal?: AbortSignal | null;
+};

package/dist/esm/utils/request-options.js

@@ -0,0 +1,8 @@
+function extractRequestOptions(request) {
+  if (!request) return {};
+  return { headers: request.headers, signal: request.signal ?? void 0 };
+}
+export {
+  extractRequestOptions
+};
+//# sourceMappingURL=request-options.js.map

package/dist/esm/utils/request-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-options.js","sources":["../../../src/utils/request-options.ts"],"sourcesContent":["/**\n * Extract `headers` and `signal` from a `Request | RequestInit` for the OpenAI\n * SDK's per-call `RequestOptions`. `Request` exposes `headers` as a `Headers`\n * instance (HeadersInit-compatible) while `RequestInit` exposes `HeadersInit`\n * directly — this helper accepts either shape so callers don't need to cast.\n *\n * Always returns an object (possibly empty) rather than `undefined` so test\n * assertions that match the second argument shape via `expect.anything()` /\n * `expect.objectContaining()` keep working when no request override was set.\n */\nexport function extractRequestOptions(\n  request: Request | RequestInit | undefined,\n): { headers?: HeadersInit; signal?: AbortSignal | null } {\n  if (!request) return {}\n  return { headers: request.headers, signal: request.signal ?? undefined }\n}\n"],"names":[],"mappings":"AAUO,SAAS,sBACd,SACwD;AACxD,MAAI,CAAC,QAAS,QAAO,CAAA;AACrB,SAAO,EAAE,SAAS,QAAQ,SAAS,QAAQ,QAAQ,UAAU,OAAA;AAC/D;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/openai-base",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Shared base adapters and utilities for OpenAI-compatible providers in TanStack AI",
   "author": "",
   "license": "MIT",
@@ -22,19 +22,6 @@
     "dist",
     "src"
   ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "vite build",
-    "clean": "premove ./build ./dist",
-    "lint:fix": "eslint ./src --fix",
-    "test:build": "publint --strict",
-    "test:eslint": "eslint ./src",
-    "test:lib": "vitest run",
-    "test:lib:dev": "pnpm test:lib --watch",
-    "test:types": "tsc"
-  },
   "keywords": [
     "ai",
     "openai",
@@ -43,15 +30,25 @@
     "base"
   ],
   "dependencies": {
-    "@tanstack/ai-utils": "workspace:*",
-    "openai": "^6.9.1"
+    "openai": "^6.9.1",
+    "@tanstack/ai-utils": "0.2.0"
   },
   "peerDependencies": {
-    "@tanstack/ai": "workspace:^"
+    "@tanstack/ai": "^0.16.0"
   },
   "devDependencies": {
-    "@tanstack/ai": "workspace:*",
     "@vitest/coverage-v8": "4.0.14",
-    "vite": "^7.2.7"
+    "vite": "^7.2.7",
+    "@tanstack/ai": "0.16.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "clean": "premove ./build ./dist",
+    "lint:fix": "eslint ./src --fix",
+    "test:build": "publint --strict",
+    "test:eslint": "eslint ./src",
+    "test:lib": "vitest run",
+    "test:lib:dev": "pnpm test:lib --watch",
+    "test:types": "tsc"
   }
 }

package/dist/esm/types/message-metadata.d.ts

@@ -1,19 +0,0 @@
-export interface OpenAICompatibleImageMetadata {
-    detail?: 'auto' | 'low' | 'high';
-}
-export interface OpenAICompatibleAudioMetadata {
-    format?: 'mp3' | 'wav' | 'flac' | 'ogg' | 'webm' | 'aac';
-}
-export interface OpenAICompatibleVideoMetadata {
-}
-export interface OpenAICompatibleDocumentMetadata {
-}
-export interface OpenAICompatibleTextMetadata {
-}
-export interface OpenAICompatibleMessageMetadataByModality {
-    text: OpenAICompatibleTextMetadata;
-    image: OpenAICompatibleImageMetadata;
-    audio: OpenAICompatibleAudioMetadata;
-    video: OpenAICompatibleVideoMetadata;
-    document: OpenAICompatibleDocumentMetadata;
-}

package/dist/esm/types/provider-options.d.ts

@@ -1,40 +0,0 @@
-export interface OpenAICompatibleBaseOptions {
-    temperature?: number;
-    top_p?: number;
-    max_tokens?: number;
-    frequency_penalty?: number;
-    presence_penalty?: number;
-    stop?: string | Array<string>;
-    user?: string;
-}
-export interface OpenAICompatibleReasoningOptions {
-    reasoning?: {
-        effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high';
-        summary?: 'auto' | 'detailed';
-    };
-}
-export interface OpenAICompatibleStructuredOutputOptions {
-    text?: {
-        format: {
-            type: string;
-            name?: string;
-            schema?: Record<string, unknown>;
-            strict?: boolean;
-        };
-    };
-}
-export interface OpenAICompatibleToolsOptions {
-    max_tool_calls?: number;
-    parallel_tool_calls?: boolean;
-    tool_choice?: 'auto' | 'none' | 'required' | {
-        type: 'function';
-        function: {
-            name: string;
-        };
-    };
-}
-export interface OpenAICompatibleStreamingOptions {
-    stream_options?: {
-        include_usage?: boolean;
-    };
-}