@tanstack/openai-base 0.1.0

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

@@ -0,0 +1,27 @@
+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 {
+    type: "image_generation",
+    ...metadata
+  };
+}
+function imageGenerationTool(toolData) {
+  validatePartialImages(toolData.partial_images);
+  return {
+    name: "image_generation",
+    description: "Generate images based on text descriptions",
+    metadata: {
+      ...toolData
+    }
+  };
+}
+export {
+  convertImageGenerationToolToAdapterFormat,
+  imageGenerationTool
+};
+//# 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 OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type ImageGenerationTool = OpenAI.Responses.Tool.ImageGeneration\n\nconst validatePartialImages = (value: number | undefined) => {\n  if (value !== undefined && (value < 0 || value > 3)) {\n    throw new Error('partial_images must be between 0 and 3')\n  }\n}\n\n/**\n * Converts a standard Tool to OpenAI ImageGenerationTool format\n */\nexport function convertImageGenerationToolToAdapterFormat(\n  tool: Tool,\n): ImageGenerationTool {\n  const metadata = tool.metadata as Omit<ImageGenerationTool, 'type'>\n  return {\n    type: 'image_generation',\n    ...metadata,\n  }\n}\n\n/**\n * Creates a standard Tool from ImageGenerationTool parameters\n */\nexport function imageGenerationTool(\n  toolData: Omit<ImageGenerationTool, 'type'>,\n): Tool {\n  validatePartialImages(toolData.partial_images)\n  return {\n    name: 'image_generation',\n    description: 'Generate images based on text descriptions',\n    metadata: {\n      ...toolData,\n    },\n  }\n}\n"],"names":[],"mappings":"AAKA,MAAM,wBAAwB,CAAC,UAA8B;AAC3D,MAAI,UAAU,WAAc,QAAQ,KAAK,QAAQ,IAAI;AACnD,UAAM,IAAI,MAAM,wCAAwC;AAAA,EAC1D;AACF;AAKO,SAAS,0CACd,MACqB;AACrB,QAAM,WAAW,KAAK;AACtB,SAAO;AAAA,IACL,MAAM;AAAA,IACN,GAAG;AAAA,EAAA;AAEP;AAKO,SAAS,oBACd,UACM;AACN,wBAAsB,SAAS,cAAc;AAC7C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU;AAAA,MACR,GAAG;AAAA,IAAA;AAAA,EACL;AAEJ;"}

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

@@ -0,0 +1,27 @@
+import { ApplyPatchTool } from './apply-patch-tool.js';
+import { CodeInterpreterTool } from './code-interpreter-tool.js';
+import { ComputerUseTool } from './computer-use-tool.js';
+import { CustomTool } from './custom-tool.js';
+import { FileSearchTool } from './file-search-tool.js';
+import { FunctionTool } from './function-tool.js';
+import { ImageGenerationTool } from './image-generation-tool.js';
+import { LocalShellTool } from './local-shell-tool.js';
+import { MCPTool } from './mcp-tool.js';
+import { ShellTool } from './shell-tool.js';
+import { WebSearchPreviewTool } from './web-search-preview-tool.js';
+import { WebSearchTool } from './web-search-tool.js';
+export type OpenAITool = ApplyPatchTool | CodeInterpreterTool | ComputerUseTool | CustomTool | FileSearchTool | FunctionTool | ImageGenerationTool | LocalShellTool | MCPTool | ShellTool | WebSearchPreviewTool | WebSearchTool;
+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 * 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,11 @@
+import { default as OpenAI } from 'openai';
+import { Tool } from '@tanstack/ai';
+export type LocalShellTool = OpenAI.Responses.Tool.LocalShell;
+/**
+ * Converts a standard Tool to OpenAI LocalShellTool format
+ */
+export declare function convertLocalShellToolToAdapterFormat(_tool: Tool): LocalShellTool;
+/**
+ * Creates a standard Tool from LocalShellTool parameters
+ */
+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 OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type LocalShellTool = OpenAI.Responses.Tool.LocalShell\n\n/**\n * Converts a standard Tool to OpenAI LocalShellTool format\n */\nexport function convertLocalShellToolToAdapterFormat(\n  _tool: Tool,\n): LocalShellTool {\n  return {\n    type: 'local_shell',\n  }\n}\n\n/**\n * Creates a standard Tool from LocalShellTool parameters\n */\nexport function localShellTool(): Tool {\n  return {\n    name: 'local_shell',\n    description: 'Execute local shell commands',\n    metadata: {},\n  }\n}\n"],"names":[],"mappings":"AAQO,SAAS,qCACd,OACgB;AAChB,SAAO;AAAA,IACL,MAAM;AAAA,EAAA;AAEV;AAKO,SAAS,iBAAuB;AACrC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU,CAAA;AAAA,EAAC;AAEf;"}

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

@@ -0,0 +1,12 @@
+import { default as OpenAI } from 'openai';
+import { Tool } from '@tanstack/ai';
+export type MCPTool = OpenAI.Responses.Tool.Mcp;
+export declare function validateMCPtool(tool: MCPTool): void;
+/**
+ * Converts a standard Tool to OpenAI MCPTool format
+ */
+export declare function convertMCPToolToAdapterFormat(tool: Tool): MCPTool;
+/**
+ * Creates a standard Tool from MCPTool parameters
+ */
+export declare function mcpTool(toolData: Omit<MCPTool, '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 OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type MCPTool = OpenAI.Responses.Tool.Mcp\n\nexport function validateMCPtool(tool: MCPTool) {\n  if (!tool.server_url && !tool.connector_id) {\n    throw new Error('Either server_url or connector_id must be provided.')\n  }\n  if (tool.connector_id && tool.server_url) {\n    throw new Error('Only one of server_url or connector_id can be provided.')\n  }\n}\n\n/**\n * Converts a standard Tool to OpenAI MCPTool format\n */\nexport function convertMCPToolToAdapterFormat(tool: Tool): MCPTool {\n  const metadata = tool.metadata as Omit<MCPTool, 'type'>\n\n  const mcpTool: MCPTool = {\n    ...metadata,\n    type: 'mcp',\n  }\n\n  validateMCPtool(mcpTool)\n  return mcpTool\n}\n\n/**\n * Creates a standard Tool from MCPTool parameters\n */\nexport function mcpTool(toolData: Omit<MCPTool, 'type'>): Tool {\n  validateMCPtool({ ...toolData, type: 'mcp' })\n\n  return {\n    name: 'mcp',\n    description: toolData.server_description || '',\n    metadata: toolData,\n  }\n}\n"],"names":["mcpTool"],"mappings":"AAKO,SAAS,gBAAgB,MAAe;AAC7C,MAAI,CAAC,KAAK,cAAc,CAAC,KAAK,cAAc;AAC1C,UAAM,IAAI,MAAM,qDAAqD;AAAA,EACvE;AACA,MAAI,KAAK,gBAAgB,KAAK,YAAY;AACxC,UAAM,IAAI,MAAM,yDAAyD;AAAA,EAC3E;AACF;AAKO,SAAS,8BAA8B,MAAqB;AACjE,QAAM,WAAW,KAAK;AAEtB,QAAMA,WAAmB;AAAA,IACvB,GAAG;AAAA,IACH,MAAM;AAAA,EAAA;AAGR,kBAAgBA,QAAO;AACvB,SAAOA;AACT;AAKO,SAAS,QAAQ,UAAuC;AAC7D,kBAAgB,EAAE,GAAG,SAAsB,CAAC;AAE5C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa,SAAS,sBAAsB;AAAA,IAC5C,UAAU;AAAA,EAAA;AAEd;"}

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

@@ -0,0 +1,11 @@
+import { default as OpenAI } from 'openai';
+import { Tool } from '@tanstack/ai';
+export type ShellTool = OpenAI.Responses.FunctionShellTool;
+/**
+ * Converts a standard Tool to OpenAI ShellTool format
+ */
+export declare function convertShellToolToAdapterFormat(_tool: Tool): ShellTool;
+/**
+ * Creates a standard Tool from ShellTool parameters
+ */
+export declare function shellTool(): Tool;

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

@@ -0,0 +1,17 @@
+function convertShellToolToAdapterFormat(_tool) {
+  return {
+    type: "shell"
+  };
+}
+function shellTool() {
+  return {
+    name: "shell",
+    description: "Execute shell commands",
+    metadata: {}
+  };
+}
+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 OpenAI from 'openai'\nimport type { Tool } from '@tanstack/ai'\n\nexport type ShellTool = OpenAI.Responses.FunctionShellTool\n\n/**\n * Converts a standard Tool to OpenAI ShellTool format\n */\nexport function convertShellToolToAdapterFormat(_tool: Tool): ShellTool {\n  return {\n    type: 'shell',\n  }\n}\n\n/**\n * Creates a standard Tool from ShellTool parameters\n */\nexport function shellTool(): Tool {\n  return {\n    name: 'shell',\n    description: 'Execute shell commands',\n    metadata: {},\n  }\n}\n"],"names":[],"mappings":"AAQO,SAAS,gCAAgC,OAAwB;AACtE,SAAO;AAAA,IACL,MAAM;AAAA,EAAA;AAEV;AAKO,SAAS,YAAkB;AAChC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,aAAa;AAAA,IACb,UAAU,CAAA;AAAA,EAAC;AAEf;"}

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();
+        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,gCAAoC;AAAA,QAC7C,KAAK;AACH,iBAAO,2CAA2C,IAAI;AAAA,QACxD,KAAK;AACH,iBAAO,oCAAoC,IAAI;AAAA,QACjD,KAAK;AACH,iBAAO,iCAAiC,IAAI;AAAA,MAAA;AAAA,IAElD;AAEA,WAAO,mCAAmC,IAAI;AAAA,EAChD,CAAC;AACH;"}

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

@@ -0,0 +1,11 @@
+import { default as OpenAI } from 'openai';
+import { Tool } from '@tanstack/ai';
+export type WebSearchPreviewTool = OpenAI.Responses.WebSearchPreviewTool;
+/**
+ * Converts a standard Tool to OpenAI WebSearchPreviewTool format
+ */
+export declare function convertWebSearchPreviewToolToAdapterFormat(tool: Tool): WebSearchPreviewTool;
+/**
+ * Creates a standard Tool from WebSearchPreviewTool parameters
+ */
+export declare function webSearchPreviewTool(toolData: WebSearchPreviewTool): Tool;

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

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

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

@@ -0,0 +1,11 @@
+import { default as OpenAI } from 'openai';
+import { Tool } from '@tanstack/ai';
+export type WebSearchTool = OpenAI.Responses.WebSearchTool;
+/**
+ * Converts a standard Tool to OpenAI WebSearchTool format
+ */
+export declare function convertWebSearchToolToAdapterFormat(tool: Tool): WebSearchTool;
+/**
+ * Creates a standard Tool from WebSearchTool parameters
+ */
+export declare function webSearchTool(toolData: WebSearchTool): Tool;

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

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

package/dist/esm/types/config.d.ts

@@ -0,0 +1,4 @@
+import { ClientOptions } from 'openai';
+export interface OpenAICompatibleClientConfig extends ClientOptions {
+    apiKey: string;
+}

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

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

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

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

package/dist/esm/utils/client.d.ts

@@ -0,0 +1,3 @@
+import { default as OpenAI } from 'openai';
+import { OpenAICompatibleClientConfig } from '../types/config.js';
+export declare function createOpenAICompatibleClient(config: OpenAICompatibleClientConfig): OpenAI;

package/dist/esm/utils/client.js

@@ -0,0 +1,8 @@
+import OpenAI from "openai";
+function createOpenAICompatibleClient(config) {
+  return new OpenAI(config);
+}
+export {
+  createOpenAICompatibleClient
+};
+//# sourceMappingURL=client.js.map

package/dist/esm/utils/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sources":["../../../src/utils/client.ts"],"sourcesContent":["import OpenAI from 'openai'\nimport type { OpenAICompatibleClientConfig } from '../types/config'\n\nexport function createOpenAICompatibleClient(\n  config: OpenAICompatibleClientConfig,\n): OpenAI {\n  return new OpenAI(config)\n}\n"],"names":[],"mappings":";AAGO,SAAS,6BACd,QACQ;AACR,SAAO,IAAI,OAAO,MAAM;AAC1B;"}

package/dist/esm/utils/schema-converter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Transform a JSON schema to be compatible with OpenAI's structured output requirements.
+ * OpenAI requires:
+ * - All properties must be in the `required` array
+ * - Optional fields should have null added to their type union
+ * - additionalProperties must be false for objects
+ *
+ * @param schema - JSON schema to transform
+ * @param originalRequired - Original required array (to know which fields were optional)
+ * @returns Transformed schema compatible with OpenAI structured output
+ */
+export declare function makeStructuredOutputCompatible(schema: Record<string, any>, originalRequired?: Array<string>): Record<string, any>;

package/dist/esm/utils/schema-converter.js

@@ -0,0 +1,65 @@
+function makeStructuredOutputCompatible(schema, originalRequired) {
+  const result = { ...schema };
+  const required = originalRequired ?? (Array.isArray(result.required) ? result.required : []);
+  if (result.type === "object" && result.properties) {
+    const properties = { ...result.properties };
+    const allPropertyNames = Object.keys(properties);
+    for (const propName of allPropertyNames) {
+      let prop = properties[propName];
+      const wasOptional = !required.includes(propName);
+      if (prop.type === "object" && prop.properties) {
+        prop = makeStructuredOutputCompatible(prop, prop.required || []);
+      } else if (prop.type === "array" && prop.items) {
+        prop = {
+          ...prop,
+          items: makeStructuredOutputCompatible(
+            prop.items,
+            prop.items.required || []
+          )
+        };
+      } else if (prop.anyOf) {
+        prop = makeStructuredOutputCompatible(prop, prop.required || []);
+      } else if (prop.oneOf) {
+        throw new Error(
+          "oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types"
+        );
+      }
+      if (wasOptional) {
+        if (prop.anyOf) {
+          if (!prop.anyOf.some((v) => v.type === "null")) {
+            prop = { ...prop, anyOf: [...prop.anyOf, { type: "null" }] };
+          }
+        } else if (prop.type && !Array.isArray(prop.type)) {
+          prop = { ...prop, type: [prop.type, "null"] };
+        } else if (Array.isArray(prop.type) && !prop.type.includes("null")) {
+          prop = { ...prop, type: [...prop.type, "null"] };
+        }
+      }
+      properties[propName] = prop;
+    }
+    result.properties = properties;
+    result.required = allPropertyNames;
+    result.additionalProperties = false;
+  }
+  if (result.type === "array" && result.items) {
+    result.items = makeStructuredOutputCompatible(
+      result.items,
+      result.items.required || []
+    );
+  }
+  if (result.anyOf && Array.isArray(result.anyOf)) {
+    result.anyOf = result.anyOf.map(
+      (variant) => makeStructuredOutputCompatible(variant, variant.required || [])
+    );
+  }
+  if (result.oneOf) {
+    throw new Error(
+      "oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types"
+    );
+  }
+  return result;
+}
+export {
+  makeStructuredOutputCompatible
+};
+//# sourceMappingURL=schema-converter.js.map

package/dist/esm/utils/schema-converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-converter.js","sources":["../../../src/utils/schema-converter.ts"],"sourcesContent":["/**\n * Transform a JSON schema to be compatible with OpenAI's structured output requirements.\n * OpenAI requires:\n * - All properties must be in the `required` array\n * - Optional fields should have null added to their type union\n * - additionalProperties must be false for objects\n *\n * @param schema - JSON schema to transform\n * @param originalRequired - Original required array (to know which fields were optional)\n * @returns Transformed schema compatible with OpenAI structured output\n */\nexport function makeStructuredOutputCompatible(\n  schema: Record<string, any>,\n  originalRequired?: Array<string>,\n): Record<string, any> {\n  const result = { ...schema }\n  const required =\n    originalRequired ?? (Array.isArray(result.required) ? result.required : [])\n\n  if (result.type === 'object' && result.properties) {\n    const properties = { ...result.properties }\n    const allPropertyNames = Object.keys(properties)\n\n    for (const propName of allPropertyNames) {\n      let prop = properties[propName]\n      const wasOptional = !required.includes(propName)\n\n      // Step 1: Recurse into nested structures\n      if (prop.type === 'object' && prop.properties) {\n        prop = makeStructuredOutputCompatible(prop, prop.required || [])\n      } else if (prop.type === 'array' && prop.items) {\n        prop = {\n          ...prop,\n          items: makeStructuredOutputCompatible(\n            prop.items,\n            prop.items.required || [],\n          ),\n        }\n      } else if (prop.anyOf) {\n        prop = makeStructuredOutputCompatible(prop, prop.required || [])\n      } else if (prop.oneOf) {\n        throw new Error(\n          'oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types',\n        )\n      }\n\n      // Step 2: Apply null-widening for optional properties (after recursion)\n      if (wasOptional) {\n        if (prop.anyOf) {\n          // For anyOf, add a null variant if not already present\n          if (!prop.anyOf.some((v: any) => v.type === 'null')) {\n            prop = { ...prop, anyOf: [...prop.anyOf, { type: 'null' }] }\n          }\n        } else if (prop.type && !Array.isArray(prop.type)) {\n          prop = { ...prop, type: [prop.type, 'null'] }\n        } else if (Array.isArray(prop.type) && !prop.type.includes('null')) {\n          prop = { ...prop, type: [...prop.type, 'null'] }\n        }\n      }\n\n      properties[propName] = prop\n    }\n\n    result.properties = properties\n    result.required = allPropertyNames\n    result.additionalProperties = false\n  }\n\n  if (result.type === 'array' && result.items) {\n    result.items = makeStructuredOutputCompatible(\n      result.items,\n      result.items.required || [],\n    )\n  }\n\n  if (result.anyOf && Array.isArray(result.anyOf)) {\n    result.anyOf = result.anyOf.map((variant) =>\n      makeStructuredOutputCompatible(variant, variant.required || []),\n    )\n  }\n\n  if (result.oneOf) {\n    throw new Error(\n      'oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types',\n    )\n  }\n\n  return result\n}\n"],"names":[],"mappings":"AAWO,SAAS,+BACd,QACA,kBACqB;AACrB,QAAM,SAAS,EAAE,GAAG,OAAA;AACpB,QAAM,WACJ,qBAAqB,MAAM,QAAQ,OAAO,QAAQ,IAAI,OAAO,WAAW;AAE1E,MAAI,OAAO,SAAS,YAAY,OAAO,YAAY;AACjD,UAAM,aAAa,EAAE,GAAG,OAAO,WAAA;AAC/B,UAAM,mBAAmB,OAAO,KAAK,UAAU;AAE/C,eAAW,YAAY,kBAAkB;AACvC,UAAI,OAAO,WAAW,QAAQ;AAC9B,YAAM,cAAc,CAAC,SAAS,SAAS,QAAQ;AAG/C,UAAI,KAAK,SAAS,YAAY,KAAK,YAAY;AAC7C,eAAO,+BAA+B,MAAM,KAAK,YAAY,CAAA,CAAE;AAAA,MACjE,WAAW,KAAK,SAAS,WAAW,KAAK,OAAO;AAC9C,eAAO;AAAA,UACL,GAAG;AAAA,UACH,OAAO;AAAA,YACL,KAAK;AAAA,YACL,KAAK,MAAM,YAAY,CAAA;AAAA,UAAC;AAAA,QAC1B;AAAA,MAEJ,WAAW,KAAK,OAAO;AACrB,eAAO,+BAA+B,MAAM,KAAK,YAAY,CAAA,CAAE;AAAA,MACjE,WAAW,KAAK,OAAO;AACrB,cAAM,IAAI;AAAA,UACR;AAAA,QAAA;AAAA,MAEJ;AAGA,UAAI,aAAa;AACf,YAAI,KAAK,OAAO;AAEd,cAAI,CAAC,KAAK,MAAM,KAAK,CAAC,MAAW,EAAE,SAAS,MAAM,GAAG;AACnD,mBAAO,EAAE,GAAG,MAAM,OAAO,CAAC,GAAG,KAAK,OAAO,EAAE,MAAM,OAAA,CAAQ,EAAA;AAAA,UAC3D;AAAA,QACF,WAAW,KAAK,QAAQ,CAAC,MAAM,QAAQ,KAAK,IAAI,GAAG;AACjD,iBAAO,EAAE,GAAG,MAAM,MAAM,CAAC,KAAK,MAAM,MAAM,EAAA;AAAA,QAC5C,WAAW,MAAM,QAAQ,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,MAAM,GAAG;AAClE,iBAAO,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,KAAK,MAAM,MAAM,EAAA;AAAA,QAC/C;AAAA,MACF;AAEA,iBAAW,QAAQ,IAAI;AAAA,IACzB;AAEA,WAAO,aAAa;AACpB,WAAO,WAAW;AAClB,WAAO,uBAAuB;AAAA,EAChC;AAEA,MAAI,OAAO,SAAS,WAAW,OAAO,OAAO;AAC3C,WAAO,QAAQ;AAAA,MACb,OAAO;AAAA,MACP,OAAO,MAAM,YAAY,CAAA;AAAA,IAAC;AAAA,EAE9B;AAEA,MAAI,OAAO,SAAS,MAAM,QAAQ,OAAO,KAAK,GAAG;AAC/C,WAAO,QAAQ,OAAO,MAAM;AAAA,MAAI,CAAC,YAC/B,+BAA+B,SAAS,QAAQ,YAAY,CAAA,CAAE;AAAA,IAAA;AAAA,EAElE;AAEA,MAAI,OAAO,OAAO;AAChB,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,SAAO;AACT;"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@tanstack/openai-base",
+  "version": "0.1.0",
+  "description": "Shared base adapters and utilities for OpenAI-compatible providers in TanStack AI",
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanStack/ai.git",
+    "directory": "packages/typescript/openai-base"
+  },
+  "type": "module",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build",
+    "clean": "premove ./build ./dist",
+    "lint:fix": "eslint ./src --fix",
+    "test:build": "publint --strict",
+    "test:eslint": "eslint ./src",
+    "test:lib": "vitest run",
+    "test:lib:dev": "pnpm test:lib --watch",
+    "test:types": "tsc"
+  },
+  "keywords": [
+    "ai",
+    "openai",
+    "tanstack",
+    "adapter",
+    "base"
+  ],
+  "dependencies": {
+    "@tanstack/ai-utils": "workspace:*",
+    "openai": "^6.9.1"
+  },
+  "peerDependencies": {
+    "@tanstack/ai": "workspace:^"
+  },
+  "devDependencies": {
+    "@tanstack/ai": "workspace:*",
+    "@vitest/coverage-v8": "4.0.14",
+    "vite": "^7.2.7"
+  }
+}