@tanstack/openai-base 0.9.9 → 0.9.10

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

@@ -1,31 +1,37 @@
+//#region src/tools/mcp-tool.ts
 function validateMCPtool(tool) {
-  if (!tool.server_url && !tool.connector_id) {
-    throw new Error("Either server_url or connector_id must be provided.");
-  }
-  if (tool.connector_id && tool.server_url) {
-    throw new Error("Only one of server_url or connector_id can be provided.");
-  }
+	if (!tool.server_url && !tool.connector_id) throw new Error("Either server_url or connector_id must be provided.");
+	if (tool.connector_id && tool.server_url) throw new Error("Only one of server_url or connector_id can be provided.");
 }
+/**
+* Converts a standard Tool to OpenAI MCPTool format
+*/
 function convertMCPToolToAdapterFormat(tool) {
-  const metadata = tool.metadata;
-  const mcpTool2 = {
-    ...metadata,
-    type: "mcp"
-  };
-  validateMCPtool(mcpTool2);
-  return mcpTool2;
+	const mcpTool = {
+		...tool.metadata,
+		type: "mcp"
+	};
+	validateMCPtool(mcpTool);
+	return mcpTool;
 }
+/**
+* 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.
+*/
 function mcpTool(toolData) {
-  validateMCPtool({ ...toolData });
-  return {
-    name: "mcp",
-    description: toolData.server_description || "",
-    metadata: toolData
-  };
+	validateMCPtool({
+		...toolData,
+		type: "mcp"
+	});
+	return {
+		name: "mcp",
+		description: toolData.server_description || "",
+		metadata: toolData
+	};
 }
-export {
-  convertMCPToolToAdapterFormat,
-  mcpTool,
-  validateMCPtool
-};
-//# sourceMappingURL=mcp-tool.js.map
+//#endregion
+export { convertMCPToolToAdapterFormat, mcpTool, validateMCPtool };
+
+//# sourceMappingURL=mcp-tool.js.map

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 { 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;"}
+{"version":3,"file":"mcp-tool.js","names":[],"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"],"mappings":";AAUA,SAAgB,gBAAgB,MAAqB;CACnD,IAAI,CAAC,KAAK,cAAc,CAAC,KAAK,cAC5B,MAAM,IAAI,MAAM,qDAAqD;CAEvE,IAAI,KAAK,gBAAgB,KAAK,YAC5B,MAAM,IAAI,MAAM,yDAAyD;AAE7E;;;;AAKA,SAAgB,8BAA8B,MAA2B;CAGvE,MAAM,UAAyB;EAC7B,GAHe,KAAK;EAIpB,MAAM;CACR;CAEA,gBAAgB,OAAO;CACvB,OAAO;AACT;;;;;;;AAQA,SAAgB,QAAQ,UAA6C;CACnE,gBAAgB;EAAE,GAAG;EAAU,MAAM;CAAM,CAAC;CAE5C,OAAO;EACL,MAAM;EACN,aAAa,SAAS,sBAAsB;EAC5C,UAAU;CACZ;AACF"}

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

@@ -1,25 +1,29 @@
+//#region src/tools/shell-tool.ts
+/**
+* Converts a standard Tool to OpenAI ShellTool format, preserving any
+* `environment` (container config + skills) stored in metadata.
+*/
 function convertShellToolToAdapterFormat(tool) {
-  const metadata = tool.metadata ?? {};
-  return {
-    type: "shell",
-    ...metadata.environment !== void 0 && {
-      environment: metadata.environment
-    }
-  };
+	const metadata = tool.metadata ?? {};
+	return {
+		type: "shell",
+		...metadata.environment !== void 0 && { environment: metadata.environment }
+	};
 }
+/**
+* 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.
+*/
 function shellTool(config = {}) {
-  return {
-    name: "shell",
-    description: "Execute shell commands",
-    metadata: {
-      ...config.environment !== void 0 && {
-        environment: config.environment
-      }
-    }
-  };
+	return {
+		name: "shell",
+		description: "Execute shell commands",
+		metadata: { ...config.environment !== void 0 && { environment: config.environment } }
+	};
 }
-export {
-  convertShellToolToAdapterFormat,
-  shellTool
-};
-//# sourceMappingURL=shell-tool.js.map
+//#endregion
+export { convertShellToolToAdapterFormat, shellTool };
+
+//# sourceMappingURL=shell-tool.js.map

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 * 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;"}
+{"version":3,"file":"shell-tool.js","names":[],"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"],"mappings":";;;;;AAsBA,SAAgB,gCAAgC,MAA6B;CAC3E,MAAM,WAAY,KAAK,YAAY,CAAC;CACpC,OAAO;EACL,MAAM;EACN,GAAI,SAAS,gBAAgB,KAAA,KAAa,EACxC,aAAa,SAAS,YACxB;CACF;AACF;;;;;;;AAQA,SAAgB,UAAU,SAAiC,CAAC,GAAS;CACnE,OAAO;EACL,MAAM;EACN,aAAa;EACb,UAAU,EACR,GAAI,OAAO,gBAAgB,KAAA,KAAa,EACtC,aAAa,OAAO,YACtB,EACF;CACF;AACF"}

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

@@ -10,52 +10,43 @@ import { convertMCPToolToAdapterFormat } from "./mcp-tool.js";
 import { convertShellToolToAdapterFormat } from "./shell-tool.js";
 import { convertWebSearchPreviewToolToAdapterFormat } from "./web-search-preview-tool.js";
 import { convertWebSearchToolToAdapterFormat } from "./web-search-tool.js";
-const SPECIAL_TOOL_NAMES = /* @__PURE__ */ new Set([
-  "apply_patch",
-  "code_interpreter",
-  "computer_use_preview",
-  "file_search",
-  "image_generation",
-  "local_shell",
-  "mcp",
-  "shell",
-  "web_search_preview",
-  "web_search",
-  "custom"
+//#region src/tools/tool-converter.ts
+var SPECIAL_TOOL_NAMES = /* @__PURE__ */ new Set([
+	"apply_patch",
+	"code_interpreter",
+	"computer_use_preview",
+	"file_search",
+	"image_generation",
+	"local_shell",
+	"mcp",
+	"shell",
+	"web_search_preview",
+	"web_search",
+	"custom"
 ]);
+/**
+* Converts an array of standard Tools to OpenAI-specific format
+*/
 function convertToolsToProviderFormat(tools) {
-  return tools.map((tool) => {
-    const toolName = tool.name;
-    if (SPECIAL_TOOL_NAMES.has(toolName)) {
-      switch (toolName) {
-        case "apply_patch":
-          return convertApplyPatchToolToAdapterFormat();
-        case "code_interpreter":
-          return convertCodeInterpreterToolToAdapterFormat(tool);
-        case "computer_use_preview":
-          return convertComputerUseToolToAdapterFormat(tool);
-        case "file_search":
-          return convertFileSearchToolToAdapterFormat(tool);
-        case "image_generation":
-          return convertImageGenerationToolToAdapterFormat(tool);
-        case "local_shell":
-          return convertLocalShellToolToAdapterFormat();
-        case "mcp":
-          return convertMCPToolToAdapterFormat(tool);
-        case "shell":
-          return convertShellToolToAdapterFormat(tool);
-        case "web_search_preview":
-          return convertWebSearchPreviewToolToAdapterFormat(tool);
-        case "web_search":
-          return convertWebSearchToolToAdapterFormat(tool);
-        case "custom":
-          return convertCustomToolToAdapterFormat(tool);
-      }
-    }
-    return convertFunctionToolToAdapterFormat(tool);
-  });
+	return tools.map((tool) => {
+		const toolName = tool.name;
+		if (SPECIAL_TOOL_NAMES.has(toolName)) switch (toolName) {
+			case "apply_patch": return convertApplyPatchToolToAdapterFormat(tool);
+			case "code_interpreter": return convertCodeInterpreterToolToAdapterFormat(tool);
+			case "computer_use_preview": return convertComputerUseToolToAdapterFormat(tool);
+			case "file_search": return convertFileSearchToolToAdapterFormat(tool);
+			case "image_generation": return convertImageGenerationToolToAdapterFormat(tool);
+			case "local_shell": return convertLocalShellToolToAdapterFormat(tool);
+			case "mcp": return convertMCPToolToAdapterFormat(tool);
+			case "shell": return convertShellToolToAdapterFormat(tool);
+			case "web_search_preview": return convertWebSearchPreviewToolToAdapterFormat(tool);
+			case "web_search": return convertWebSearchToolToAdapterFormat(tool);
+			case "custom": return convertCustomToolToAdapterFormat(tool);
+		}
+		return convertFunctionToolToAdapterFormat(tool);
+	});
 }
-export {
-  convertToolsToProviderFormat
-};
-//# sourceMappingURL=tool-converter.js.map
+//#endregion
+export { convertToolsToProviderFormat };
+
+//# sourceMappingURL=tool-converter.js.map

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,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;"}
+{"version":3,"file":"tool-converter.js","names":[],"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"],"mappings":";;;;;;;;;;;;;AAeA,IAAM,qCAAqB,IAAI,IAAI;CACjC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF,CAAC;;;;AAKD,SAAgB,6BACd,OACmB;CACnB,OAAO,MAAM,KAAK,SAAS;EACzB,MAAM,WAAW,KAAK;EAEtB,IAAI,mBAAmB,IAAI,QAAQ,GACjC,QAAQ,UAAR;GACE,KAAK,eACH,OAAO,qCAAqC,IAAI;GAClD,KAAK,oBACH,OAAO,0CAA0C,IAAI;GACvD,KAAK,wBACH,OAAO,sCAAsC,IAAI;GACnD,KAAK,eACH,OAAO,qCAAqC,IAAI;GAClD,KAAK,oBACH,OAAO,0CAA0C,IAAI;GACvD,KAAK,eACH,OAAO,qCAAqC,IAAI;GAClD,KAAK,OACH,OAAO,8BAA8B,IAAI;GAC3C,KAAK,SACH,OAAO,gCAAgC,IAAI;GAC7C,KAAK,sBACH,OAAO,2CAA2C,IAAI;GACxD,KAAK,cACH,OAAO,oCAAoC,IAAI;GACjD,KAAK,UACH,OAAO,iCAAiC,IAAI;EAChD;EAGF,OAAO,mCAAmC,IAAI;CAChD,CAAC;AACH"}

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

@@ -1,19 +1,30 @@
+//#region src/tools/web-search-preview-tool.ts
+/**
+* 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`.
+*/
 function convertWebSearchPreviewToolToAdapterFormat(tool) {
-  const metadata = tool.metadata;
-  return {
-    ...metadata,
-    type: "web_search_preview"
-  };
+	return {
+		...tool.metadata,
+		type: "web_search_preview"
+	};
 }
+/**
+* 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.
+*/
 function webSearchPreviewTool(toolData) {
-  return {
-    name: "web_search_preview",
-    description: "Search the web (preview version)",
-    metadata: toolData
-  };
+	return {
+		name: "web_search_preview",
+		description: "Search the web (preview version)",
+		metadata: toolData
+	};
 }
-export {
-  convertWebSearchPreviewToolToAdapterFormat,
-  webSearchPreviewTool
-};
-//# sourceMappingURL=web-search-preview-tool.js.map
+//#endregion
+export { convertWebSearchPreviewToolToAdapterFormat, webSearchPreviewTool };
+
+//# sourceMappingURL=web-search-preview-tool.js.map

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 { 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;"}
+{"version":3,"file":"web-search-preview-tool.js","names":[],"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"],"mappings":";;;;;;;AAcA,SAAgB,2CACd,MAC4B;CAE5B,OAAO;EACL,GAFe,KAAK;EAGpB,MAAM;CACR;AACF;;;;;;;AAQA,SAAgB,qBACd,UACM;CACN,OAAO;EACL,MAAM;EACN,aAAa;EACb,UAAU;CACZ;AACF"}

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

@@ -1,19 +1,31 @@
+//#region src/tools/web-search-tool.ts
+/**
+* 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.
+*/
 function convertWebSearchToolToAdapterFormat(tool) {
-  const metadata = tool.metadata;
-  return {
-    ...metadata,
-    type: "web_search"
-  };
+	return {
+		...tool.metadata,
+		type: "web_search"
+	};
 }
+/**
+* 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.
+*/
 function webSearchTool(toolData) {
-  return {
-    name: "web_search",
-    description: "Search the web",
-    metadata: toolData
-  };
+	return {
+		name: "web_search",
+		description: "Search the web",
+		metadata: toolData
+	};
 }
-export {
-  convertWebSearchToolToAdapterFormat,
-  webSearchTool
-};
-//# sourceMappingURL=web-search-tool.js.map
+//#endregion
+export { convertWebSearchToolToAdapterFormat, webSearchTool };
+
+//# sourceMappingURL=web-search-tool.js.map

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 { 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;"}
+{"version":3,"file":"web-search-tool.js","names":[],"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"],"mappings":";;;;;;;;AAeA,SAAgB,oCACd,MACqB;CAErB,OAAO;EACL,GAFe,KAAK;EAGpB,MAAM;CACR;AACF;;;;;;;AAQA,SAAgB,cAAc,UAAqC;CACjE,OAAO;EACL,MAAM;EACN,aAAa;EACb,UAAU;CACZ;AACF"}

package/dist/esm/usage.js

@@ -1,83 +1,95 @@
 import { buildBaseUsage } from "@tanstack/ai";
+//#region src/usage.ts
+/**
+* Build normalized {@link TokenUsage} from an OpenAI-compatible Chat
+* Completions `usage` object.
+*
+* Shared by every provider that routes through
+* {@link OpenAIBaseChatCompletionsTextAdapter} (OpenAI Chat Completions, Grok,
+* Groq). Surfaces cached prompt tokens and reasoning/audio detail tokens when
+* the provider reports them. Returns `undefined` when the provider reported no
+* usage object, so callers omit the field rather than fabricating zeroed totals.
+*/
 function buildChatCompletionsUsage(usage) {
-  if (!usage) return void 0;
-  const result = buildBaseUsage({
-    promptTokens: usage.prompt_tokens || 0,
-    completionTokens: usage.completion_tokens || 0,
-    totalTokens: usage.total_tokens || 0
-  });
-  const completionDetails = usage.completion_tokens_details;
-  const completionTokensDetails = {
-    ...completionDetails?.reasoning_tokens ? { reasoningTokens: completionDetails.reasoning_tokens } : {},
-    ...completionDetails?.audio_tokens ? { audioTokens: completionDetails.audio_tokens } : {}
-  };
-  const promptDetails = usage.prompt_tokens_details;
-  const promptTokensDetails = {
-    ...promptDetails?.cached_tokens ? { cachedTokens: promptDetails.cached_tokens } : {},
-    ...promptDetails?.audio_tokens ? { audioTokens: promptDetails.audio_tokens } : {}
-  };
-  if (Object.keys(completionTokensDetails).length > 0) {
-    result.completionTokensDetails = completionTokensDetails;
-  }
-  if (Object.keys(promptTokensDetails).length > 0) {
-    result.promptTokensDetails = promptTokensDetails;
-  }
-  const providerUsageDetails = {
-    ...completionDetails?.accepted_prediction_tokens ? {
-      acceptedPredictionTokens: completionDetails.accepted_prediction_tokens
-    } : {},
-    ...completionDetails?.rejected_prediction_tokens ? {
-      rejectedPredictionTokens: completionDetails.rejected_prediction_tokens
-    } : {}
-  };
-  if (Object.keys(providerUsageDetails).length > 0) {
-    result.providerUsageDetails = providerUsageDetails;
-  }
-  return result;
+	if (!usage) return void 0;
+	const result = buildBaseUsage({
+		promptTokens: usage.prompt_tokens || 0,
+		completionTokens: usage.completion_tokens || 0,
+		totalTokens: usage.total_tokens || 0
+	});
+	const completionDetails = usage.completion_tokens_details;
+	const completionTokensDetails = {
+		...completionDetails?.reasoning_tokens ? { reasoningTokens: completionDetails.reasoning_tokens } : {},
+		...completionDetails?.audio_tokens ? { audioTokens: completionDetails.audio_tokens } : {}
+	};
+	const promptDetails = usage.prompt_tokens_details;
+	const promptTokensDetails = {
+		...promptDetails?.cached_tokens ? { cachedTokens: promptDetails.cached_tokens } : {},
+		...promptDetails?.audio_tokens ? { audioTokens: promptDetails.audio_tokens } : {}
+	};
+	if (Object.keys(completionTokensDetails).length > 0) result.completionTokensDetails = completionTokensDetails;
+	if (Object.keys(promptTokensDetails).length > 0) result.promptTokensDetails = promptTokensDetails;
+	const providerUsageDetails = {
+		...completionDetails?.accepted_prediction_tokens ? { acceptedPredictionTokens: completionDetails.accepted_prediction_tokens } : {},
+		...completionDetails?.rejected_prediction_tokens ? { rejectedPredictionTokens: completionDetails.rejected_prediction_tokens } : {}
+	};
+	if (Object.keys(providerUsageDetails).length > 0) result.providerUsageDetails = providerUsageDetails;
+	return result;
 }
+/**
+* Build normalized {@link TokenUsage} from an OpenAI Responses API
+* `ResponseUsage` object.
+*
+* Shared by every provider that routes through
+* {@link OpenAIBaseResponsesTextAdapter}. Surfaces cached prompt tokens and
+* reasoning detail tokens when present. Returns `undefined` when the provider
+* reported no usage object, so callers omit the field rather than fabricating
+* zeroed totals.
+*/
 function buildResponsesUsage(usage) {
-  if (!usage) return void 0;
-  const result = buildBaseUsage({
-    promptTokens: usage.input_tokens || 0,
-    completionTokens: usage.output_tokens || 0,
-    totalTokens: usage.total_tokens || 0
-  });
-  const cachedTokens = usage.input_tokens_details?.cached_tokens;
-  if (cachedTokens && cachedTokens > 0) {
-    result.promptTokensDetails = {
-      ...result.promptTokensDetails,
-      cachedTokens
-    };
-  }
-  const reasoningTokens = usage.output_tokens_details?.reasoning_tokens;
-  if (reasoningTokens && reasoningTokens > 0) {
-    result.completionTokensDetails = {
-      ...result.completionTokensDetails,
-      reasoningTokens
-    };
-  }
-  return result;
+	if (!usage) return void 0;
+	const result = buildBaseUsage({
+		promptTokens: usage.input_tokens || 0,
+		completionTokens: usage.output_tokens || 0,
+		totalTokens: usage.total_tokens || 0
+	});
+	const cachedTokens = usage.input_tokens_details?.cached_tokens;
+	if (cachedTokens && cachedTokens > 0) result.promptTokensDetails = {
+		...result.promptTokensDetails,
+		cachedTokens
+	};
+	const reasoningTokens = usage.output_tokens_details?.reasoning_tokens;
+	if (reasoningTokens && reasoningTokens > 0) result.completionTokensDetails = {
+		...result.completionTokensDetails,
+		reasoningTokens
+	};
+	return result;
 }
+/**
+* Build normalized {@link TokenUsage} from an OpenAI Images API `usage` object.
+*
+* Shared by every provider that generates images through the OpenAI Images SDK
+* (OpenAI, Grok). Token-billed image models (e.g. gpt-image-1) report an input
+* breakdown of text vs image tokens, which is surfaced on `promptTokensDetails`.
+* Models that don't return usage (e.g. DALL·E) yield `undefined` so callers can
+* omit the field rather than emit zeroed totals.
+*/
 function buildImagesUsage(usage) {
-  if (!usage) return void 0;
-  const result = buildBaseUsage({
-    promptTokens: usage.input_tokens || 0,
-    completionTokens: usage.output_tokens || 0,
-    totalTokens: usage.total_tokens || 0
-  });
-  const inputDetails = usage.input_tokens_details;
-  const promptTokensDetails = {
-    ...inputDetails?.text_tokens ? { textTokens: inputDetails.text_tokens } : {},
-    ...inputDetails?.image_tokens ? { imageTokens: inputDetails.image_tokens } : {}
-  };
-  if (Object.keys(promptTokensDetails).length > 0) {
-    result.promptTokensDetails = promptTokensDetails;
-  }
-  return result;
+	if (!usage) return void 0;
+	const result = buildBaseUsage({
+		promptTokens: usage.input_tokens || 0,
+		completionTokens: usage.output_tokens || 0,
+		totalTokens: usage.total_tokens || 0
+	});
+	const inputDetails = usage.input_tokens_details;
+	const promptTokensDetails = {
+		...inputDetails?.text_tokens ? { textTokens: inputDetails.text_tokens } : {},
+		...inputDetails?.image_tokens ? { imageTokens: inputDetails.image_tokens } : {}
+	};
+	if (Object.keys(promptTokensDetails).length > 0) result.promptTokensDetails = promptTokensDetails;
+	return result;
 }
-export {
-  buildChatCompletionsUsage,
-  buildImagesUsage,
-  buildResponsesUsage
-};
-//# sourceMappingURL=usage.js.map
+//#endregion
+export { buildChatCompletionsUsage, buildImagesUsage, buildResponsesUsage };
+
+//# sourceMappingURL=usage.js.map

package/dist/esm/usage.js.map

@@ -1 +1 @@
-{"version":3,"file":"usage.js","sources":["../../src/usage.ts"],"sourcesContent":["import { buildBaseUsage } from '@tanstack/ai'\nimport type { TokenUsage } from '@tanstack/ai'\nimport type OpenAI from 'openai'\n\n/**\n * Build normalized {@link TokenUsage} from an OpenAI-compatible Chat\n * Completions `usage` object.\n *\n * Shared by every provider that routes through\n * {@link OpenAIBaseChatCompletionsTextAdapter} (OpenAI Chat Completions, Grok,\n * Groq). Surfaces cached prompt tokens and reasoning/audio detail tokens when\n * the provider reports them. Returns `undefined` when the provider reported no\n * usage object, so callers omit the field rather than fabricating zeroed totals.\n */\nexport function buildChatCompletionsUsage(\n  usage: OpenAI.Chat.Completions.ChatCompletion['usage'] | undefined | null,\n): TokenUsage | undefined {\n  if (!usage) return undefined\n\n  const result = buildBaseUsage({\n    promptTokens: usage.prompt_tokens || 0,\n    completionTokens: usage.completion_tokens || 0,\n    totalTokens: usage.total_tokens || 0,\n  })\n\n  const completionDetails = usage.completion_tokens_details\n  const completionTokensDetails = {\n    ...(completionDetails?.reasoning_tokens\n      ? { reasoningTokens: completionDetails.reasoning_tokens }\n      : {}),\n    ...(completionDetails?.audio_tokens\n      ? { audioTokens: completionDetails.audio_tokens }\n      : {}),\n  }\n\n  const promptDetails = usage.prompt_tokens_details\n  const promptTokensDetails = {\n    ...(promptDetails?.cached_tokens\n      ? { cachedTokens: promptDetails.cached_tokens }\n      : {}),\n    ...(promptDetails?.audio_tokens\n      ? { audioTokens: promptDetails.audio_tokens }\n      : {}),\n  }\n\n  if (Object.keys(completionTokensDetails).length > 0) {\n    result.completionTokensDetails = completionTokensDetails\n  }\n  if (Object.keys(promptTokensDetails).length > 0) {\n    result.promptTokensDetails = promptTokensDetails\n  }\n\n  // Predicted Outputs accepted/rejected counts have no canonical TokenUsage\n  // slot but are still billed (rejected tokens included), so surface them under\n  // providerUsageDetails — matching how the OpenRouter adapter exposes them.\n  const providerUsageDetails = {\n    ...(completionDetails?.accepted_prediction_tokens\n      ? {\n          acceptedPredictionTokens:\n            completionDetails.accepted_prediction_tokens,\n        }\n      : {}),\n    ...(completionDetails?.rejected_prediction_tokens\n      ? {\n          rejectedPredictionTokens:\n            completionDetails.rejected_prediction_tokens,\n        }\n      : {}),\n  }\n  if (Object.keys(providerUsageDetails).length > 0) {\n    result.providerUsageDetails = providerUsageDetails\n  }\n\n  return result\n}\n\n/**\n * Build normalized {@link TokenUsage} from an OpenAI Responses API\n * `ResponseUsage` object.\n *\n * Shared by every provider that routes through\n * {@link OpenAIBaseResponsesTextAdapter}. Surfaces cached prompt tokens and\n * reasoning detail tokens when present. Returns `undefined` when the provider\n * reported no usage object, so callers omit the field rather than fabricating\n * zeroed totals.\n */\nexport function buildResponsesUsage(\n  usage: OpenAI.Responses.ResponseUsage | undefined | null,\n): TokenUsage | undefined {\n  if (!usage) return undefined\n\n  const result = buildBaseUsage({\n    promptTokens: usage.input_tokens || 0,\n    completionTokens: usage.output_tokens || 0,\n    totalTokens: usage.total_tokens || 0,\n  })\n\n  // Despite the SDK types marking these required, they can be undefined at runtime.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n  const cachedTokens = usage.input_tokens_details?.cached_tokens\n  if (cachedTokens && cachedTokens > 0) {\n    result.promptTokensDetails = {\n      ...result.promptTokensDetails,\n      cachedTokens,\n    }\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n  const reasoningTokens = usage.output_tokens_details?.reasoning_tokens\n  if (reasoningTokens && reasoningTokens > 0) {\n    result.completionTokensDetails = {\n      ...result.completionTokensDetails,\n      reasoningTokens,\n    }\n  }\n\n  return result\n}\n\n/**\n * Build normalized {@link TokenUsage} from an OpenAI Images API `usage` object.\n *\n * Shared by every provider that generates images through the OpenAI Images SDK\n * (OpenAI, Grok). Token-billed image models (e.g. gpt-image-1) report an input\n * breakdown of text vs image tokens, which is surfaced on `promptTokensDetails`.\n * Models that don't return usage (e.g. DALL·E) yield `undefined` so callers can\n * omit the field rather than emit zeroed totals.\n */\nexport function buildImagesUsage(\n  usage: OpenAI.Images.ImagesResponse['usage'] | undefined | null,\n): TokenUsage | undefined {\n  if (!usage) return undefined\n\n  const result = buildBaseUsage({\n    promptTokens: usage.input_tokens || 0,\n    completionTokens: usage.output_tokens || 0,\n    totalTokens: usage.total_tokens || 0,\n  })\n\n  // The SDK types input_tokens_details (and its numeric fields) as required, but\n  // real responses — e.g. from DALL·E or other non-token-billed models — can\n  // omit them, so treat the breakdown as optional.\n  const inputDetails = usage.input_tokens_details as\n    | { text_tokens?: number; image_tokens?: number }\n    | undefined\n  const promptTokensDetails = {\n    ...(inputDetails?.text_tokens\n      ? { textTokens: inputDetails.text_tokens }\n      : {}),\n    ...(inputDetails?.image_tokens\n      ? { imageTokens: inputDetails.image_tokens }\n      : {}),\n  }\n  if (Object.keys(promptTokensDetails).length > 0) {\n    result.promptTokensDetails = promptTokensDetails\n  }\n\n  return result\n}\n"],"names":[],"mappings":";AAcO,SAAS,0BACd,OACwB;AACxB,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,SAAS,eAAe;AAAA,IAC5B,cAAc,MAAM,iBAAiB;AAAA,IACrC,kBAAkB,MAAM,qBAAqB;AAAA,IAC7C,aAAa,MAAM,gBAAgB;AAAA,EAAA,CACpC;AAED,QAAM,oBAAoB,MAAM;AAChC,QAAM,0BAA0B;AAAA,IAC9B,GAAI,mBAAmB,mBACnB,EAAE,iBAAiB,kBAAkB,iBAAA,IACrC,CAAA;AAAA,IACJ,GAAI,mBAAmB,eACnB,EAAE,aAAa,kBAAkB,aAAA,IACjC,CAAA;AAAA,EAAC;AAGP,QAAM,gBAAgB,MAAM;AAC5B,QAAM,sBAAsB;AAAA,IAC1B,GAAI,eAAe,gBACf,EAAE,cAAc,cAAc,cAAA,IAC9B,CAAA;AAAA,IACJ,GAAI,eAAe,eACf,EAAE,aAAa,cAAc,aAAA,IAC7B,CAAA;AAAA,EAAC;AAGP,MAAI,OAAO,KAAK,uBAAuB,EAAE,SAAS,GAAG;AACnD,WAAO,0BAA0B;AAAA,EACnC;AACA,MAAI,OAAO,KAAK,mBAAmB,EAAE,SAAS,GAAG;AAC/C,WAAO,sBAAsB;AAAA,EAC/B;AAKA,QAAM,uBAAuB;AAAA,IAC3B,GAAI,mBAAmB,6BACnB;AAAA,MACE,0BACE,kBAAkB;AAAA,IAAA,IAEtB,CAAA;AAAA,IACJ,GAAI,mBAAmB,6BACnB;AAAA,MACE,0BACE,kBAAkB;AAAA,IAAA,IAEtB,CAAA;AAAA,EAAC;AAEP,MAAI,OAAO,KAAK,oBAAoB,EAAE,SAAS,GAAG;AAChD,WAAO,uBAAuB;AAAA,EAChC;AAEA,SAAO;AACT;AAYO,SAAS,oBACd,OACwB;AACxB,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,SAAS,eAAe;AAAA,IAC5B,cAAc,MAAM,gBAAgB;AAAA,IACpC,kBAAkB,MAAM,iBAAiB;AAAA,IACzC,aAAa,MAAM,gBAAgB;AAAA,EAAA,CACpC;AAID,QAAM,eAAe,MAAM,sBAAsB;AACjD,MAAI,gBAAgB,eAAe,GAAG;AACpC,WAAO,sBAAsB;AAAA,MAC3B,GAAG,OAAO;AAAA,MACV;AAAA,IAAA;AAAA,EAEJ;AAGA,QAAM,kBAAkB,MAAM,uBAAuB;AACrD,MAAI,mBAAmB,kBAAkB,GAAG;AAC1C,WAAO,0BAA0B;AAAA,MAC/B,GAAG,OAAO;AAAA,MACV;AAAA,IAAA;AAAA,EAEJ;AAEA,SAAO;AACT;AAWO,SAAS,iBACd,OACwB;AACxB,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,SAAS,eAAe;AAAA,IAC5B,cAAc,MAAM,gBAAgB;AAAA,IACpC,kBAAkB,MAAM,iBAAiB;AAAA,IACzC,aAAa,MAAM,gBAAgB;AAAA,EAAA,CACpC;AAKD,QAAM,eAAe,MAAM;AAG3B,QAAM,sBAAsB;AAAA,IAC1B,GAAI,cAAc,cACd,EAAE,YAAY,aAAa,YAAA,IAC3B,CAAA;AAAA,IACJ,GAAI,cAAc,eACd,EAAE,aAAa,aAAa,aAAA,IAC5B,CAAA;AAAA,EAAC;AAEP,MAAI,OAAO,KAAK,mBAAmB,EAAE,SAAS,GAAG;AAC/C,WAAO,sBAAsB;AAAA,EAC/B;AAEA,SAAO;AACT;"}
+{"version":3,"file":"usage.js","names":[],"sources":["../../src/usage.ts"],"sourcesContent":["import { buildBaseUsage } from '@tanstack/ai'\nimport type { TokenUsage } from '@tanstack/ai'\nimport type OpenAI from 'openai'\n\n/**\n * Build normalized {@link TokenUsage} from an OpenAI-compatible Chat\n * Completions `usage` object.\n *\n * Shared by every provider that routes through\n * {@link OpenAIBaseChatCompletionsTextAdapter} (OpenAI Chat Completions, Grok,\n * Groq). Surfaces cached prompt tokens and reasoning/audio detail tokens when\n * the provider reports them. Returns `undefined` when the provider reported no\n * usage object, so callers omit the field rather than fabricating zeroed totals.\n */\nexport function buildChatCompletionsUsage(\n  usage: OpenAI.Chat.Completions.ChatCompletion['usage'] | undefined | null,\n): TokenUsage | undefined {\n  if (!usage) return undefined\n\n  const result = buildBaseUsage({\n    promptTokens: usage.prompt_tokens || 0,\n    completionTokens: usage.completion_tokens || 0,\n    totalTokens: usage.total_tokens || 0,\n  })\n\n  const completionDetails = usage.completion_tokens_details\n  const completionTokensDetails = {\n    ...(completionDetails?.reasoning_tokens\n      ? { reasoningTokens: completionDetails.reasoning_tokens }\n      : {}),\n    ...(completionDetails?.audio_tokens\n      ? { audioTokens: completionDetails.audio_tokens }\n      : {}),\n  }\n\n  const promptDetails = usage.prompt_tokens_details\n  const promptTokensDetails = {\n    ...(promptDetails?.cached_tokens\n      ? { cachedTokens: promptDetails.cached_tokens }\n      : {}),\n    ...(promptDetails?.audio_tokens\n      ? { audioTokens: promptDetails.audio_tokens }\n      : {}),\n  }\n\n  if (Object.keys(completionTokensDetails).length > 0) {\n    result.completionTokensDetails = completionTokensDetails\n  }\n  if (Object.keys(promptTokensDetails).length > 0) {\n    result.promptTokensDetails = promptTokensDetails\n  }\n\n  // Predicted Outputs accepted/rejected counts have no canonical TokenUsage\n  // slot but are still billed (rejected tokens included), so surface them under\n  // providerUsageDetails — matching how the OpenRouter adapter exposes them.\n  const providerUsageDetails = {\n    ...(completionDetails?.accepted_prediction_tokens\n      ? {\n          acceptedPredictionTokens:\n            completionDetails.accepted_prediction_tokens,\n        }\n      : {}),\n    ...(completionDetails?.rejected_prediction_tokens\n      ? {\n          rejectedPredictionTokens:\n            completionDetails.rejected_prediction_tokens,\n        }\n      : {}),\n  }\n  if (Object.keys(providerUsageDetails).length > 0) {\n    result.providerUsageDetails = providerUsageDetails\n  }\n\n  return result\n}\n\n/**\n * Build normalized {@link TokenUsage} from an OpenAI Responses API\n * `ResponseUsage` object.\n *\n * Shared by every provider that routes through\n * {@link OpenAIBaseResponsesTextAdapter}. Surfaces cached prompt tokens and\n * reasoning detail tokens when present. Returns `undefined` when the provider\n * reported no usage object, so callers omit the field rather than fabricating\n * zeroed totals.\n */\nexport function buildResponsesUsage(\n  usage: OpenAI.Responses.ResponseUsage | undefined | null,\n): TokenUsage | undefined {\n  if (!usage) return undefined\n\n  const result = buildBaseUsage({\n    promptTokens: usage.input_tokens || 0,\n    completionTokens: usage.output_tokens || 0,\n    totalTokens: usage.total_tokens || 0,\n  })\n\n  // Despite the SDK types marking these required, they can be undefined at runtime.\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n  const cachedTokens = usage.input_tokens_details?.cached_tokens\n  if (cachedTokens && cachedTokens > 0) {\n    result.promptTokensDetails = {\n      ...result.promptTokensDetails,\n      cachedTokens,\n    }\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n  const reasoningTokens = usage.output_tokens_details?.reasoning_tokens\n  if (reasoningTokens && reasoningTokens > 0) {\n    result.completionTokensDetails = {\n      ...result.completionTokensDetails,\n      reasoningTokens,\n    }\n  }\n\n  return result\n}\n\n/**\n * Build normalized {@link TokenUsage} from an OpenAI Images API `usage` object.\n *\n * Shared by every provider that generates images through the OpenAI Images SDK\n * (OpenAI, Grok). Token-billed image models (e.g. gpt-image-1) report an input\n * breakdown of text vs image tokens, which is surfaced on `promptTokensDetails`.\n * Models that don't return usage (e.g. DALL·E) yield `undefined` so callers can\n * omit the field rather than emit zeroed totals.\n */\nexport function buildImagesUsage(\n  usage: OpenAI.Images.ImagesResponse['usage'] | undefined | null,\n): TokenUsage | undefined {\n  if (!usage) return undefined\n\n  const result = buildBaseUsage({\n    promptTokens: usage.input_tokens || 0,\n    completionTokens: usage.output_tokens || 0,\n    totalTokens: usage.total_tokens || 0,\n  })\n\n  // The SDK types input_tokens_details (and its numeric fields) as required, but\n  // real responses — e.g. from DALL·E or other non-token-billed models — can\n  // omit them, so treat the breakdown as optional.\n  const inputDetails = usage.input_tokens_details as\n    | { text_tokens?: number; image_tokens?: number }\n    | undefined\n  const promptTokensDetails = {\n    ...(inputDetails?.text_tokens\n      ? { textTokens: inputDetails.text_tokens }\n      : {}),\n    ...(inputDetails?.image_tokens\n      ? { imageTokens: inputDetails.image_tokens }\n      : {}),\n  }\n  if (Object.keys(promptTokensDetails).length > 0) {\n    result.promptTokensDetails = promptTokensDetails\n  }\n\n  return result\n}\n"],"mappings":";;;;;;;;;;;;AAcA,SAAgB,0BACd,OACwB;CACxB,IAAI,CAAC,OAAO,OAAO,KAAA;CAEnB,MAAM,SAAS,eAAe;EAC5B,cAAc,MAAM,iBAAiB;EACrC,kBAAkB,MAAM,qBAAqB;EAC7C,aAAa,MAAM,gBAAgB;CACrC,CAAC;CAED,MAAM,oBAAoB,MAAM;CAChC,MAAM,0BAA0B;EAC9B,GAAI,mBAAmB,mBACnB,EAAE,iBAAiB,kBAAkB,iBAAiB,IACtD,CAAC;EACL,GAAI,mBAAmB,eACnB,EAAE,aAAa,kBAAkB,aAAa,IAC9C,CAAC;CACP;CAEA,MAAM,gBAAgB,MAAM;CAC5B,MAAM,sBAAsB;EAC1B,GAAI,eAAe,gBACf,EAAE,cAAc,cAAc,cAAc,IAC5C,CAAC;EACL,GAAI,eAAe,eACf,EAAE,aAAa,cAAc,aAAa,IAC1C,CAAC;CACP;CAEA,IAAI,OAAO,KAAK,uBAAuB,CAAC,CAAC,SAAS,GAChD,OAAO,0BAA0B;CAEnC,IAAI,OAAO,KAAK,mBAAmB,CAAC,CAAC,SAAS,GAC5C,OAAO,sBAAsB;CAM/B,MAAM,uBAAuB;EAC3B,GAAI,mBAAmB,6BACnB,EACE,0BACE,kBAAkB,2BACtB,IACA,CAAC;EACL,GAAI,mBAAmB,6BACnB,EACE,0BACE,kBAAkB,2BACtB,IACA,CAAC;CACP;CACA,IAAI,OAAO,KAAK,oBAAoB,CAAC,CAAC,SAAS,GAC7C,OAAO,uBAAuB;CAGhC,OAAO;AACT;;;;;;;;;;;AAYA,SAAgB,oBACd,OACwB;CACxB,IAAI,CAAC,OAAO,OAAO,KAAA;CAEnB,MAAM,SAAS,eAAe;EAC5B,cAAc,MAAM,gBAAgB;EACpC,kBAAkB,MAAM,iBAAiB;EACzC,aAAa,MAAM,gBAAgB;CACrC,CAAC;CAID,MAAM,eAAe,MAAM,sBAAsB;CACjD,IAAI,gBAAgB,eAAe,GACjC,OAAO,sBAAsB;EAC3B,GAAG,OAAO;EACV;CACF;CAIF,MAAM,kBAAkB,MAAM,uBAAuB;CACrD,IAAI,mBAAmB,kBAAkB,GACvC,OAAO,0BAA0B;EAC/B,GAAG,OAAO;EACV;CACF;CAGF,OAAO;AACT;;;;;;;;;;AAWA,SAAgB,iBACd,OACwB;CACxB,IAAI,CAAC,OAAO,OAAO,KAAA;CAEnB,MAAM,SAAS,eAAe;EAC5B,cAAc,MAAM,gBAAgB;EACpC,kBAAkB,MAAM,iBAAiB;EACzC,aAAa,MAAM,gBAAgB;CACrC,CAAC;CAKD,MAAM,eAAe,MAAM;CAG3B,MAAM,sBAAsB;EAC1B,GAAI,cAAc,cACd,EAAE,YAAY,aAAa,YAAY,IACvC,CAAC;EACL,GAAI,cAAc,eACd,EAAE,aAAa,aAAa,aAAa,IACzC,CAAC;CACP;CACA,IAAI,OAAO,KAAK,mBAAmB,CAAC,CAAC,SAAS,GAC5C,OAAO,sBAAsB;CAG/B,OAAO;AACT"}

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

@@ -1,11 +1,22 @@
+//#region src/utils/request-options.ts
+/**
+* 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.
+*/
 function extractRequestOptions(request) {
-  if (!request) return {};
-  return {
-    ...request.headers !== void 0 && { headers: request.headers },
-    ...request.signal != null && { signal: request.signal }
-  };
+	if (!request) return {};
+	return {
+		...request.headers !== void 0 && { headers: request.headers },
+		...request.signal != null && { signal: request.signal }
+	};
 }
-export {
-  extractRequestOptions
-};
-//# sourceMappingURL=request-options.js.map
+//#endregion
+export { extractRequestOptions };
+
+//# sourceMappingURL=request-options.js.map