@tanstack/openai-base 0.9.3 → 0.9.5

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

@@ -0,0 +1,35 @@
+const validateMaxNumResults = (maxNumResults) => {
+  if (maxNumResults !== void 0 && (maxNumResults < 1 || maxNumResults > 50)) {
+    throw new Error("max_num_results must be between 1 and 50.");
+  }
+};
+function convertFileSearchToolToAdapterFormat(tool) {
+  const metadata = tool.metadata;
+  return {
+    type: "file_search",
+    vector_store_ids: metadata.vector_store_ids,
+    ...metadata.max_num_results !== void 0 && {
+      max_num_results: metadata.max_num_results
+    },
+    ...metadata.ranking_options !== void 0 && {
+      ranking_options: metadata.ranking_options
+    },
+    ...metadata.filters !== void 0 && { filters: metadata.filters }
+  };
+}
+function fileSearchTool(toolData) {
+  validateMaxNumResults(toolData.max_num_results);
+  return {
+    name: "file_search",
+    description: "Search files in vector stores",
+    metadata: {
+      ...toolData
+    }
+  };
+}
+export {
+  convertFileSearchToolToAdapterFormat,
+  fileSearchTool,
+  validateMaxNumResults
+};
+//# sourceMappingURL=file-search-tool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file-search-tool.js","sources":["../../../src/tools/file-search-tool.ts"],"sourcesContent":["import type { FileSearchTool as FileSearchToolConfig } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\nexport type { FileSearchToolConfig }\n\nconst validateMaxNumResults = (maxNumResults: number | undefined) => {\n  if (\n    maxNumResults !== undefined &&\n    (maxNumResults < 1 || maxNumResults > 50)\n  ) {\n    throw new Error('max_num_results must be between 1 and 50.')\n  }\n}\n\n/** @deprecated Renamed to `FileSearchToolConfig`. Will be removed in a future release. */\nexport type FileSearchTool = FileSearchToolConfig\n\n/**\n * Converts a standard Tool to OpenAI FileSearchTool format\n */\nexport function convertFileSearchToolToAdapterFormat(\n  tool: Tool,\n): FileSearchToolConfig {\n  const metadata = tool.metadata as FileSearchToolConfig\n  // Conditional spread: SDK's `FileSearchToolConfig` declares the\n  // optional fields without `| undefined`, so we omit absent values\n  // rather than passing them through as explicit `undefined`.\n  return {\n    type: 'file_search',\n    vector_store_ids: metadata.vector_store_ids,\n    ...(metadata.max_num_results !== undefined && {\n      max_num_results: metadata.max_num_results,\n    }),\n    ...(metadata.ranking_options !== undefined && {\n      ranking_options: metadata.ranking_options,\n    }),\n    ...(metadata.filters !== undefined && { filters: metadata.filters }),\n  }\n}\n\n/**\n * Creates a standard Tool from FileSearchTool parameters.\n *\n * Validates max_num_results. Base (non-branded) factory; providers that need\n * branded return types should re-wrap in their own package.\n */\nexport function fileSearchTool(toolData: FileSearchToolConfig): Tool {\n  validateMaxNumResults(toolData.max_num_results)\n  return {\n    name: 'file_search',\n    description: 'Search files in vector stores',\n    metadata: {\n      ...toolData,\n    },\n  }\n}\n\nexport { validateMaxNumResults }\n"],"names":[],"mappings":"AAKA,MAAM,wBAAwB,CAAC,kBAAsC;AACnE,MACE,kBAAkB,WACjB,gBAAgB,KAAK,gBAAgB,KACtC;AACA,UAAM,IAAI,MAAM,2CAA2C;AAAA,EAC7D;AACF;AAQO,SAAS,qCACd,MACsB;AACtB,QAAM,WAAW,KAAK;AAItB,SAAO;AAAA,IACL,MAAM;AAAA,IACN,kBAAkB,SAAS;AAAA,IAC3B,GAAI,SAAS,oBAAoB,UAAa;AAAA,MAC5C,iBAAiB,SAAS;AAAA,IAAA;AAAA,IAE5B,GAAI,SAAS,oBAAoB,UAAa;AAAA,MAC5C,iBAAiB,SAAS;AAAA,IAAA;AAAA,IAE5B,GAAI,SAAS,YAAY,UAAa,EAAE,SAAS,SAAS,QAAA;AAAA,EAAQ;AAEtE;AAQO,SAAS,eAAe,UAAsC;AACnE,wBAAsB,SAAS,eAAe;AAC9C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,MACR,GAAG;AAAA,IAAA;AAAA,EACL;AAEJ;"}

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

@@ -0,0 +1,23 @@
+import { FunctionTool as FunctionToolConfig } from 'openai/resources/responses/responses';
+import { Tool } from '@tanstack/ai';
+export type { FunctionToolConfig };
+/** @deprecated Renamed to `FunctionToolConfig`. Will be removed in a future release. */
+export type FunctionTool = FunctionToolConfig;
+/**
+ * Converts a standard Tool to OpenAI FunctionTool format.
+ *
+ * Tool schemas are already converted to JSON Schema in the ai layer.
+ * We apply OpenAI-specific transformations for strict mode:
+ * - All properties in required array
+ * - Optional fields made nullable
+ * - additionalProperties: false
+ *
+ * This enables strict mode for all tools automatically.
+ *
+ * Some tool schemas (e.g. MCP server tools that use `oneOf`, `$ref`, or
+ * `$defs`) cannot be expressed under OpenAI's strict Structured Outputs
+ * subset. For those we fall back to a non-strict tool definition — stripping
+ * only the formats OpenAI rejects — so the tool is still usable instead of
+ * failing the request with a 400 "Invalid schema" error.
+ */
+export declare function convertFunctionToolToAdapterFormat(tool: Tool): FunctionToolConfig;

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

@@ -0,0 +1,33 @@
+import { isStrictModeCompatible, stripUnsupportedFormats, makeStructuredOutputCompatible } from "../utils/schema-converter.js";
+function convertFunctionToolToAdapterFormat(tool) {
+  const inputSchema = tool.inputSchema ?? {
+    type: "object",
+    properties: {},
+    required: []
+  };
+  if (!isStrictModeCompatible(inputSchema)) {
+    return {
+      type: "function",
+      name: tool.name,
+      description: tool.description,
+      parameters: stripUnsupportedFormats(inputSchema),
+      strict: false
+    };
+  }
+  const jsonSchema = makeStructuredOutputCompatible(
+    inputSchema,
+    inputSchema.required || []
+  );
+  jsonSchema.additionalProperties = false;
+  return {
+    type: "function",
+    name: tool.name,
+    description: tool.description,
+    parameters: jsonSchema,
+    strict: true
+  };
+}
+export {
+  convertFunctionToolToAdapterFormat
+};
+//# sourceMappingURL=function-tool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"function-tool.js","sources":["../../../src/tools/function-tool.ts"],"sourcesContent":["import {\n  isStrictModeCompatible,\n  makeStructuredOutputCompatible,\n  stripUnsupportedFormats,\n} from '../utils/schema-converter'\nimport type { FunctionTool as FunctionToolConfig } from 'openai/resources/responses/responses'\nimport type { JSONSchema, Tool } from '@tanstack/ai'\n\nexport type { FunctionToolConfig }\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 *\n * Some tool schemas (e.g. MCP server tools that use `oneOf`, `$ref`, or\n * `$defs`) cannot be expressed under OpenAI's strict Structured Outputs\n * subset. For those we fall back to a non-strict tool definition — stripping\n * only the formats OpenAI rejects — so the tool is still usable instead of\n * failing the request with a 400 \"Invalid schema\" error.\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  if (!isStrictModeCompatible(inputSchema)) {\n    return {\n      type: 'function',\n      name: tool.name,\n      description: tool.description,\n      parameters: stripUnsupportedFormats(inputSchema),\n      strict: false,\n    } satisfies FunctionToolConfig\n  }\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":";AA8BO,SAAS,mCACd,MACoB;AACpB,QAAM,cAAe,KAAK,eAAe;AAAA,IACvC,MAAM;AAAA,IACN,YAAY,CAAA;AAAA,IACZ,UAAU,CAAA;AAAA,EAAC;AAGb,MAAI,CAAC,uBAAuB,WAAW,GAAG;AACxC,WAAO;AAAA,MACL,MAAM;AAAA,MACN,MAAM,KAAK;AAAA,MACX,aAAa,KAAK;AAAA,MAClB,YAAY,wBAAwB,WAAW;AAAA,MAC/C,QAAQ;AAAA,IAAA;AAAA,EAEZ;AAEA,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

@@ -0,0 +1,23 @@
+import { Tool as SDKTool } from 'openai/resources/responses/responses';
+import { Tool } from '@tanstack/ai';
+type ImageGenerationToolConfig = SDKTool.ImageGeneration;
+export type { ImageGenerationToolConfig };
+/** @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. 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): ImageGenerationToolConfig;
+/**
+ * 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<ImageGenerationToolConfig, 'type'>): Tool;
+export { validatePartialImages };

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

@@ -0,0 +1,28 @@
+const validatePartialImages = (value) => {
+  if (value !== void 0 && (value < 0 || value > 3)) {
+    throw new Error("partial_images must be between 0 and 3");
+  }
+};
+function convertImageGenerationToolToAdapterFormat(tool) {
+  const metadata = tool.metadata;
+  return {
+    ...metadata,
+    type: "image_generation"
+  };
+}
+function imageGenerationTool(toolData) {
+  validatePartialImages(toolData.partial_images);
+  return {
+    name: "image_generation",
+    description: "Generate images based on text descriptions",
+    metadata: {
+      ...toolData
+    }
+  };
+}
+export {
+  convertImageGenerationToolToAdapterFormat,
+  imageGenerationTool,
+  validatePartialImages
+};
+//# sourceMappingURL=image-generation-tool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"image-generation-tool.js","sources":["../../../src/tools/image-generation-tool.ts"],"sourcesContent":["import type { Tool as SDKTool } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\ntype ImageGenerationToolConfig = SDKTool.ImageGeneration\n\nexport type { ImageGenerationToolConfig }\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":"AAUA,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

@@ -0,0 +1,27 @@
+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';
+export * from './custom-tool.js';
+export * from './file-search-tool.js';
+export * from './function-tool.js';
+export * from './image-generation-tool.js';
+export * from './local-shell-tool.js';
+export * from './mcp-tool.js';
+export * from './shell-tool.js';
+export type * from './tool-choice.js';
+export * from './tool-converter.js';
+export * from './web-search-preview-tool.js';
+export * from './web-search-tool.js';

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

@@ -0,0 +1,17 @@
+import { Tool as SDKTool } from 'openai/resources/responses/responses';
+import { Tool } from '@tanstack/ai';
+type LocalShellToolConfig = SDKTool.LocalShell;
+export type { LocalShellToolConfig };
+/** @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): LocalShellToolConfig;
+/**
+ * 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

@@ -0,0 +1,17 @@
+function convertLocalShellToolToAdapterFormat(_tool) {
+  return {
+    type: "local_shell"
+  };
+}
+function localShellTool() {
+  return {
+    name: "local_shell",
+    description: "Execute local shell commands",
+    metadata: {}
+  };
+}
+export {
+  convertLocalShellToolToAdapterFormat,
+  localShellTool
+};
+//# sourceMappingURL=local-shell-tool.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"local-shell-tool.js","sources":["../../../src/tools/local-shell-tool.ts"],"sourcesContent":["import type { Tool as SDKTool } from 'openai/resources/responses/responses'\nimport type { Tool } from '@tanstack/ai'\n\ntype LocalShellToolConfig = SDKTool.LocalShell\n\nexport type { LocalShellToolConfig }\n\n/** @deprecated Renamed to `LocalShellToolConfig`. Will be removed in a future release. */\nexport type LocalShellTool = LocalShellToolConfig\n\n/**\n * Converts a standard Tool to OpenAI LocalShellTool format\n */\nexport function convertLocalShellToolToAdapterFormat(\n  _tool: Tool,\n): LocalShellToolConfig {\n  return {\n    type: 'local_shell',\n  }\n}\n\n/**\n * Creates a standard Tool from LocalShellTool parameters.\n *\n * Base (non-branded) factory. Providers that need branded return types should\n * re-wrap this in their own package.\n */\nexport function localShellTool(): Tool {\n  return {\n    name: 'local_shell',\n    description: 'Execute local shell commands',\n    metadata: {},\n  }\n}\n"],"names":[],"mappings":"AAaO,SAAS,qCACd,OACsB;AACtB,SAAO;AAAA,IACL,MAAM;AAAA,EAAA;AAEV;AAQO,SAAS,iBAAuB;AACrC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU,CAAA;AAAA,EAAC;AAEf;"}

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

@@ -0,0 +1,18 @@
+import { Tool as SDKTool } from 'openai/resources/responses/responses';
+import { Tool } from '@tanstack/ai';
+type MCPToolConfig = SDKTool.Mcp;
+export type { MCPToolConfig };
+/** @deprecated Renamed to `MCPToolConfig`. Will be removed in a future release. */
+export type MCPTool = MCPToolConfig;
+export declare function validateMCPtool(tool: MCPToolConfig): void;
+/**
+ * Converts a standard Tool to OpenAI MCPTool format
+ */
+export declare function convertMCPToolToAdapterFormat(tool: Tool): MCPToolConfig;
+/**
+ * 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<MCPToolConfig, 'type'>): Tool;

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

@@ -0,0 +1,31 @@
+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.");
+  }
+}
+function convertMCPToolToAdapterFormat(tool) {
+  const metadata = tool.metadata;
+  const mcpTool2 = {
+    ...metadata,
+    type: "mcp"
+  };
+  validateMCPtool(mcpTool2);
+  return mcpTool2;
+}
+function mcpTool(toolData) {
+  validateMCPtool({ ...toolData });
+  return {
+    name: "mcp",
+    description: toolData.server_description || "",
+    metadata: toolData
+  };
+}
+export {
+  convertMCPToolToAdapterFormat,
+  mcpTool,
+  validateMCPtool
+};
+//# sourceMappingURL=mcp-tool.js.map

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

@@ -0,0 +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;"}

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

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

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

@@ -0,0 +1,25 @@
+function convertShellToolToAdapterFormat(tool) {
+  const metadata = tool.metadata ?? {};
+  return {
+    type: "shell",
+    ...metadata.environment !== void 0 && {
+      environment: metadata.environment
+    }
+  };
+}
+function shellTool(config = {}) {
+  return {
+    name: "shell",
+    description: "Execute shell commands",
+    metadata: {
+      ...config.environment !== void 0 && {
+        environment: config.environment
+      }
+    }
+  };
+}
+export {
+  convertShellToolToAdapterFormat,
+  shellTool
+};
+//# sourceMappingURL=shell-tool.js.map

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

@@ -0,0 +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;"}

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

@@ -0,0 +1,17 @@
+interface MCPToolChoice {
+    type: 'mcp';
+    server_label: string;
+}
+interface FunctionToolChoice {
+    type: 'function';
+    name: string;
+}
+interface CustomToolChoice {
+    type: 'custom';
+    name: string;
+}
+interface HostedToolChoice {
+    type: 'file_search' | 'web_search_preview' | 'computer_use_preview' | 'code_interpreter' | 'image_generation' | 'shell' | 'apply_patch';
+}
+export type ToolChoice = MCPToolChoice | FunctionToolChoice | CustomToolChoice | HostedToolChoice;
+export {};

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

@@ -0,0 +1,6 @@
+import { OpenAITool } from './index.js';
+import { Tool } from '@tanstack/ai';
+/**
+ * Converts an array of standard Tools to OpenAI-specific format
+ */
+export declare function convertToolsToProviderFormat(tools: Array<Tool>): Array<OpenAITool>;

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

@@ -0,0 +1,61 @@
+import { convertApplyPatchToolToAdapterFormat } from "./apply-patch-tool.js";
+import { convertCodeInterpreterToolToAdapterFormat } from "./code-interpreter-tool.js";
+import { convertComputerUseToolToAdapterFormat } from "./computer-use-tool.js";
+import { convertCustomToolToAdapterFormat } from "./custom-tool.js";
+import { convertFileSearchToolToAdapterFormat } from "./file-search-tool.js";
+import { convertFunctionToolToAdapterFormat } from "./function-tool.js";
+import { convertImageGenerationToolToAdapterFormat } from "./image-generation-tool.js";
+import { convertLocalShellToolToAdapterFormat } from "./local-shell-tool.js";
+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"
+]);
+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);
+  });
+}
+export {
+  convertToolsToProviderFormat
+};
+//# sourceMappingURL=tool-converter.js.map

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

@@ -0,0 +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;"}

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

@@ -0,0 +1,19 @@
+import { WebSearchPreviewTool as WebSearchPreviewToolConfig } from 'openai/resources/responses/responses';
+import { Tool } from '@tanstack/ai';
+export type { WebSearchPreviewToolConfig };
+/** @deprecated Renamed to `WebSearchPreviewToolConfig`. Will be removed in a future release. */
+export type WebSearchPreviewTool = WebSearchPreviewToolConfig;
+/**
+ * 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): WebSearchPreviewToolConfig;
+/**
+ * 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: WebSearchPreviewToolConfig): Tool;

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

@@ -0,0 +1,19 @@
+function convertWebSearchPreviewToolToAdapterFormat(tool) {
+  const metadata = tool.metadata;
+  return {
+    ...metadata,
+    type: "web_search_preview"
+  };
+}
+function webSearchPreviewTool(toolData) {
+  return {
+    name: "web_search_preview",
+    description: "Search the web (preview version)",
+    metadata: toolData
+  };
+}
+export {
+  convertWebSearchPreviewToolToAdapterFormat,
+  webSearchPreviewTool
+};
+//# sourceMappingURL=web-search-preview-tool.js.map

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

@@ -0,0 +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;"}

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

@@ -0,0 +1,20 @@
+import { WebSearchTool as WebSearchToolConfig } from 'openai/resources/responses/responses';
+import { Tool } from '@tanstack/ai';
+export type { WebSearchToolConfig };
+/** @deprecated Renamed to `WebSearchToolConfig`. Will be removed in a future release. */
+export type WebSearchTool = WebSearchToolConfig;
+/**
+ * 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): WebSearchToolConfig;
+/**
+ * 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: WebSearchToolConfig): Tool;

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

@@ -0,0 +1,19 @@
+function convertWebSearchToolToAdapterFormat(tool) {
+  const metadata = tool.metadata;
+  return {
+    ...metadata,
+    type: "web_search"
+  };
+}
+function webSearchTool(toolData) {
+  return {
+    name: "web_search",
+    description: "Search the web",
+    metadata: toolData
+  };
+}
+export {
+  convertWebSearchToolToAdapterFormat,
+  webSearchTool
+};
+//# sourceMappingURL=web-search-tool.js.map

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

@@ -0,0 +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;"}

package/dist/esm/usage.d.ts

@@ -0,0 +1,34 @@
+import { TokenUsage } from '@tanstack/ai';
+import { default as OpenAI } from 'openai';
+/**
+ * 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.
+ */
+export declare function buildChatCompletionsUsage(usage: OpenAI.Chat.Completions.ChatCompletion['usage'] | undefined | null): TokenUsage | undefined;
+/**
+ * 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.
+ */
+export declare function buildResponsesUsage(usage: OpenAI.Responses.ResponseUsage | undefined | null): TokenUsage | undefined;
+/**
+ * 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.
+ */
+export declare function buildImagesUsage(usage: OpenAI.Images.ImagesResponse['usage'] | undefined | null): TokenUsage | undefined;