@tanstack/openai-base 0.9.1 → 0.9.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/package.json +3 -3
  2. package/src/utils/schema-converter.ts +73 -8
  3. package/dist/esm/adapters/chat-completions-text.d.ts +0 -116
  4. package/dist/esm/adapters/chat-completions-text.js +0 -967
  5. package/dist/esm/adapters/chat-completions-text.js.map +0 -1
  6. package/dist/esm/adapters/chat-completions-tool-converter.d.ts +0 -35
  7. package/dist/esm/adapters/chat-completions-tool-converter.js +0 -42
  8. package/dist/esm/adapters/chat-completions-tool-converter.js.map +0 -1
  9. package/dist/esm/adapters/responses-text.d.ts +0 -135
  10. package/dist/esm/adapters/responses-text.js +0 -1324
  11. package/dist/esm/adapters/responses-text.js.map +0 -1
  12. package/dist/esm/adapters/responses-tool-converter.d.ts +0 -42
  13. package/dist/esm/adapters/responses-tool-converter.js +0 -38
  14. package/dist/esm/adapters/responses-tool-converter.js.map +0 -1
  15. package/dist/esm/index.d.ts +0 -7
  16. package/dist/esm/index.js +0 -59
  17. package/dist/esm/index.js.map +0 -1
  18. package/dist/esm/tools/apply-patch-tool.d.ts +0 -16
  19. package/dist/esm/tools/apply-patch-tool.js +0 -17
  20. package/dist/esm/tools/apply-patch-tool.js.map +0 -1
  21. package/dist/esm/tools/code-interpreter-tool.d.ts +0 -17
  22. package/dist/esm/tools/code-interpreter-tool.js +0 -22
  23. package/dist/esm/tools/code-interpreter-tool.js.map +0 -1
  24. package/dist/esm/tools/computer-use-tool.d.ts +0 -16
  25. package/dist/esm/tools/computer-use-tool.js +0 -23
  26. package/dist/esm/tools/computer-use-tool.js.map +0 -1
  27. package/dist/esm/tools/custom-tool.d.ts +0 -13
  28. package/dist/esm/tools/custom-tool.js +0 -25
  29. package/dist/esm/tools/custom-tool.js.map +0 -1
  30. package/dist/esm/tools/file-search-tool.d.ts +0 -18
  31. package/dist/esm/tools/file-search-tool.js +0 -35
  32. package/dist/esm/tools/file-search-tool.js.map +0 -1
  33. package/dist/esm/tools/function-tool.d.ts +0 -23
  34. package/dist/esm/tools/function-tool.js +0 -33
  35. package/dist/esm/tools/function-tool.js.map +0 -1
  36. package/dist/esm/tools/image-generation-tool.d.ts +0 -23
  37. package/dist/esm/tools/image-generation-tool.js +0 -28
  38. package/dist/esm/tools/image-generation-tool.js.map +0 -1
  39. package/dist/esm/tools/index.d.ts +0 -27
  40. package/dist/esm/tools/local-shell-tool.d.ts +0 -17
  41. package/dist/esm/tools/local-shell-tool.js +0 -17
  42. package/dist/esm/tools/local-shell-tool.js.map +0 -1
  43. package/dist/esm/tools/mcp-tool.d.ts +0 -18
  44. package/dist/esm/tools/mcp-tool.js +0 -31
  45. package/dist/esm/tools/mcp-tool.js.map +0 -1
  46. package/dist/esm/tools/shell-tool.d.ts +0 -26
  47. package/dist/esm/tools/shell-tool.js +0 -25
  48. package/dist/esm/tools/shell-tool.js.map +0 -1
  49. package/dist/esm/tools/tool-choice.d.ts +0 -17
  50. package/dist/esm/tools/tool-converter.d.ts +0 -6
  51. package/dist/esm/tools/tool-converter.js +0 -61
  52. package/dist/esm/tools/tool-converter.js.map +0 -1
  53. package/dist/esm/tools/web-search-preview-tool.d.ts +0 -19
  54. package/dist/esm/tools/web-search-preview-tool.js +0 -19
  55. package/dist/esm/tools/web-search-preview-tool.js.map +0 -1
  56. package/dist/esm/tools/web-search-tool.d.ts +0 -20
  57. package/dist/esm/tools/web-search-tool.js +0 -19
  58. package/dist/esm/tools/web-search-tool.js.map +0 -1
  59. package/dist/esm/usage.d.ts +0 -34
  60. package/dist/esm/usage.js +0 -83
  61. package/dist/esm/usage.js.map +0 -1
  62. package/dist/esm/utils/request-options.d.ts +0 -14
  63. package/dist/esm/utils/request-options.js +0 -11
  64. package/dist/esm/utils/request-options.js.map +0 -1
  65. package/dist/esm/utils/schema-converter.d.ts +0 -34
  66. package/dist/esm/utils/schema-converter.js +0 -109
  67. package/dist/esm/utils/schema-converter.js.map +0 -1
package/dist/esm/usage.js DELETED
@@ -1,83 +0,0 @@
1
- import { buildBaseUsage } from "@tanstack/ai";
2
- function buildChatCompletionsUsage(usage) {
3
- if (!usage) return void 0;
4
- const result = buildBaseUsage({
5
- promptTokens: usage.prompt_tokens || 0,
6
- completionTokens: usage.completion_tokens || 0,
7
- totalTokens: usage.total_tokens || 0
8
- });
9
- const completionDetails = usage.completion_tokens_details;
10
- const completionTokensDetails = {
11
- ...completionDetails?.reasoning_tokens ? { reasoningTokens: completionDetails.reasoning_tokens } : {},
12
- ...completionDetails?.audio_tokens ? { audioTokens: completionDetails.audio_tokens } : {}
13
- };
14
- const promptDetails = usage.prompt_tokens_details;
15
- const promptTokensDetails = {
16
- ...promptDetails?.cached_tokens ? { cachedTokens: promptDetails.cached_tokens } : {},
17
- ...promptDetails?.audio_tokens ? { audioTokens: promptDetails.audio_tokens } : {}
18
- };
19
- if (Object.keys(completionTokensDetails).length > 0) {
20
- result.completionTokensDetails = completionTokensDetails;
21
- }
22
- if (Object.keys(promptTokensDetails).length > 0) {
23
- result.promptTokensDetails = promptTokensDetails;
24
- }
25
- const providerUsageDetails = {
26
- ...completionDetails?.accepted_prediction_tokens ? {
27
- acceptedPredictionTokens: completionDetails.accepted_prediction_tokens
28
- } : {},
29
- ...completionDetails?.rejected_prediction_tokens ? {
30
- rejectedPredictionTokens: completionDetails.rejected_prediction_tokens
31
- } : {}
32
- };
33
- if (Object.keys(providerUsageDetails).length > 0) {
34
- result.providerUsageDetails = providerUsageDetails;
35
- }
36
- return result;
37
- }
38
- function buildResponsesUsage(usage) {
39
- if (!usage) return void 0;
40
- const result = buildBaseUsage({
41
- promptTokens: usage.input_tokens || 0,
42
- completionTokens: usage.output_tokens || 0,
43
- totalTokens: usage.total_tokens || 0
44
- });
45
- const cachedTokens = usage.input_tokens_details?.cached_tokens;
46
- if (cachedTokens && cachedTokens > 0) {
47
- result.promptTokensDetails = {
48
- ...result.promptTokensDetails,
49
- cachedTokens
50
- };
51
- }
52
- const reasoningTokens = usage.output_tokens_details?.reasoning_tokens;
53
- if (reasoningTokens && reasoningTokens > 0) {
54
- result.completionTokensDetails = {
55
- ...result.completionTokensDetails,
56
- reasoningTokens
57
- };
58
- }
59
- return result;
60
- }
61
- function buildImagesUsage(usage) {
62
- if (!usage) return void 0;
63
- const result = buildBaseUsage({
64
- promptTokens: usage.input_tokens || 0,
65
- completionTokens: usage.output_tokens || 0,
66
- totalTokens: usage.total_tokens || 0
67
- });
68
- const inputDetails = usage.input_tokens_details;
69
- const promptTokensDetails = {
70
- ...inputDetails?.text_tokens ? { textTokens: inputDetails.text_tokens } : {},
71
- ...inputDetails?.image_tokens ? { imageTokens: inputDetails.image_tokens } : {}
72
- };
73
- if (Object.keys(promptTokensDetails).length > 0) {
74
- result.promptTokensDetails = promptTokensDetails;
75
- }
76
- return result;
77
- }
78
- export {
79
- buildChatCompletionsUsage,
80
- buildImagesUsage,
81
- buildResponsesUsage
82
- };
83
- //# sourceMappingURL=usage.js.map
@@ -1 +0,0 @@
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;"}
@@ -1,14 +0,0 @@
1
- /**
2
- * Extract `headers` and `signal` from a `Request | RequestInit` for the OpenAI
3
- * SDK's per-call `RequestOptions`. `Request` exposes `headers` as a `Headers`
4
- * instance (HeadersInit-compatible) while `RequestInit` exposes `HeadersInit`
5
- * directly — this helper accepts either shape so callers don't need to cast.
6
- *
7
- * Always returns an object (possibly empty) rather than `undefined` so test
8
- * assertions that match the second argument shape via `expect.anything()` /
9
- * `expect.objectContaining()` keep working when no request override was set.
10
- */
11
- export declare function extractRequestOptions(request: Request | RequestInit | undefined): {
12
- headers?: HeadersInit;
13
- signal?: AbortSignal | null;
14
- };
@@ -1,11 +0,0 @@
1
- function extractRequestOptions(request) {
2
- if (!request) return {};
3
- return {
4
- ...request.headers !== void 0 && { headers: request.headers },
5
- ...request.signal != null && { signal: request.signal }
6
- };
7
- }
8
- export {
9
- extractRequestOptions
10
- };
11
- //# sourceMappingURL=request-options.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"request-options.js","sources":["../../../src/utils/request-options.ts"],"sourcesContent":["/**\n * Extract `headers` and `signal` from a `Request | RequestInit` for the OpenAI\n * SDK's per-call `RequestOptions`. `Request` exposes `headers` as a `Headers`\n * instance (HeadersInit-compatible) while `RequestInit` exposes `HeadersInit`\n * directly — this helper accepts either shape so callers don't need to cast.\n *\n * Always returns an object (possibly empty) rather than `undefined` so test\n * assertions that match the second argument shape via `expect.anything()` /\n * `expect.objectContaining()` keep working when no request override was set.\n */\nexport function extractRequestOptions(\n request: Request | RequestInit | undefined,\n): { headers?: HeadersInit; signal?: AbortSignal | null } {\n if (!request) return {}\n // Conditional spread: under exactOptionalPropertyTypes the target's\n // `headers?: HeadersInit` and `signal?: AbortSignal | null` forbid an\n // explicit `undefined`. Omit the keys entirely when the source values\n // are absent so the OpenAI SDK sees `headers: undefined` as \"not set\"\n // rather than a present-but-undefined value.\n return {\n ...(request.headers !== undefined && { headers: request.headers }),\n ...(request.signal != null && { signal: request.signal }),\n }\n}\n"],"names":[],"mappings":"AAUO,SAAS,sBACd,SACwD;AACxD,MAAI,CAAC,QAAS,QAAO,CAAA;AAMrB,SAAO;AAAA,IACL,GAAI,QAAQ,YAAY,UAAa,EAAE,SAAS,QAAQ,QAAA;AAAA,IACxD,GAAI,QAAQ,UAAU,QAAQ,EAAE,QAAQ,QAAQ,OAAA;AAAA,EAAO;AAE3D;"}
@@ -1,34 +0,0 @@
1
- /**
2
- * Recursively drop JSON-Schema `format` keywords whose value isn't in OpenAI's
3
- * strict-mode allowlist. Pure — returns a fresh tree and never mutates `node`,
4
- * so the caller's original tool definition is left intact.
5
- *
6
- * A property *named* `format` always has a schema (object/boolean) value, never
7
- * a bare string, so it is preserved and recursed into; only the `format`
8
- * *keyword* (whose value is a string) is subject to removal.
9
- */
10
- export declare function stripUnsupportedFormats(node: any): any;
11
- /**
12
- * Transform a JSON schema to be compatible with OpenAI's structured output requirements.
13
- * OpenAI requires:
14
- * - All properties must be in the `required` array
15
- * - Optional fields should have null added to their type union
16
- * - additionalProperties must be false for objects
17
- * - String `format` keywords must be from a fixed allowlist (others are stripped)
18
- *
19
- * @param schema - JSON schema to transform
20
- * @param originalRequired - Original required array (to know which fields were optional)
21
- * @returns Transformed schema compatible with OpenAI structured output
22
- */
23
- export declare function makeStructuredOutputCompatible(schema: Record<string, any>, originalRequired?: Array<string>): Record<string, any>;
24
- /**
25
- * Returns `false` when `schema` (anywhere in the tree) uses a JSON-Schema
26
- * keyword outside OpenAI's strict Structured Outputs subset — i.e. it cannot be
27
- * made strict-compatible and must be sent with `strict: false`.
28
- *
29
- * Conservative by design: keywords are matched as object keys, so a property
30
- * literally named e.g. `oneOf` also trips it. That only costs that one tool its
31
- * strict mode, which is strictly safer than a false "compatible" verdict that
32
- * 400s the whole request.
33
- */
34
- export declare function isStrictModeCompatible(schema: unknown): boolean;
@@ -1,109 +0,0 @@
1
- const SUPPORTED_STRING_FORMATS = /* @__PURE__ */ new Set([
2
- "date-time",
3
- "time",
4
- "date",
5
- "duration",
6
- "email",
7
- "hostname",
8
- "ipv4",
9
- "ipv6",
10
- "uuid"
11
- ]);
12
- function stripUnsupportedFormats(node) {
13
- if (Array.isArray(node)) return node.map(stripUnsupportedFormats);
14
- if (node === null || typeof node !== "object") return node;
15
- const out = {};
16
- for (const [key, value] of Object.entries(node)) {
17
- if (key === "format" && typeof value === "string" && !SUPPORTED_STRING_FORMATS.has(value)) {
18
- continue;
19
- }
20
- out[key] = stripUnsupportedFormats(value);
21
- }
22
- return out;
23
- }
24
- function makeStructuredOutputCompatible(schema, originalRequired) {
25
- return stripUnsupportedFormats(coerceStrictSchema(schema, originalRequired));
26
- }
27
- const STRICT_UNSUPPORTED_KEYWORDS = [
28
- "oneOf",
29
- "allOf",
30
- "not",
31
- "$ref",
32
- "$defs",
33
- "definitions"
34
- ];
35
- function isStrictModeCompatible(schema) {
36
- return !containsStrictUnsupportedKeyword(schema);
37
- }
38
- function containsStrictUnsupportedKeyword(node) {
39
- if (Array.isArray(node)) {
40
- return node.some(containsStrictUnsupportedKeyword);
41
- }
42
- if (node === null || typeof node !== "object") return false;
43
- for (const [key, value] of Object.entries(node)) {
44
- if (STRICT_UNSUPPORTED_KEYWORDS.includes(key)) return true;
45
- if (containsStrictUnsupportedKeyword(value)) return true;
46
- }
47
- return false;
48
- }
49
- function coerceStrictSchema(schema, originalRequired) {
50
- const result = { ...schema };
51
- const required = originalRequired ?? (Array.isArray(result["required"]) ? result["required"] : []);
52
- if (result.type === "object" && result.properties) {
53
- const properties = { ...result.properties };
54
- const allPropertyNames = Object.keys(properties);
55
- for (const propName of allPropertyNames) {
56
- let prop = properties[propName];
57
- const wasOptional = !required.includes(propName);
58
- if (prop.type === "object" && prop.properties) {
59
- prop = coerceStrictSchema(prop, prop.required || []);
60
- } else if (prop.type === "array" && prop.items) {
61
- prop = {
62
- ...prop,
63
- items: coerceStrictSchema(prop.items, prop.items.required || [])
64
- };
65
- } else if (prop.anyOf) {
66
- prop = coerceStrictSchema(prop, prop.required || []);
67
- } else if (prop.oneOf) {
68
- throw new Error(
69
- "oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types"
70
- );
71
- }
72
- if (wasOptional) {
73
- if (prop.anyOf) {
74
- if (!prop.anyOf.some((v) => v.type === "null")) {
75
- prop = { ...prop, anyOf: [...prop.anyOf, { type: "null" }] };
76
- }
77
- } else if (prop.type && !Array.isArray(prop.type)) {
78
- prop = { ...prop, type: [prop.type, "null"] };
79
- } else if (Array.isArray(prop.type) && !prop.type.includes("null")) {
80
- prop = { ...prop, type: [...prop.type, "null"] };
81
- }
82
- }
83
- properties[propName] = prop;
84
- }
85
- result.properties = properties;
86
- result.required = allPropertyNames;
87
- result.additionalProperties = false;
88
- }
89
- if (result.type === "array" && result.items) {
90
- result.items = coerceStrictSchema(result.items, result.items.required || []);
91
- }
92
- if (result.anyOf && Array.isArray(result.anyOf)) {
93
- result.anyOf = result.anyOf.map(
94
- (variant) => coerceStrictSchema(variant, variant.required || [])
95
- );
96
- }
97
- if (result.oneOf) {
98
- throw new Error(
99
- "oneOf is not supported in OpenAI structured output schemas. Check the supported outputs here: https://platform.openai.com/docs/guides/structured-outputs#supported-types"
100
- );
101
- }
102
- return result;
103
- }
104
- export {
105
- isStrictModeCompatible,
106
- makeStructuredOutputCompatible,
107
- stripUnsupportedFormats
108
- };
109
- //# sourceMappingURL=schema-converter.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"schema-converter.js","sources":["../../../src/utils/schema-converter.ts"],"sourcesContent":["/**\n * String `format` values accepted by OpenAI's strict Structured Outputs subset.\n * Any other format (e.g. \"uri\", \"uri-reference\", \"regex\") causes the API to\n * reject the whole request with `400 ... '<format>' is not a valid format`.\n * MCP servers and hand-written tools routinely declare such formats, so we strip\n * the unsupported ones before sending. See:\n * https://platform.openai.com/docs/guides/structured-outputs#supported-properties\n */\nconst SUPPORTED_STRING_FORMATS = new Set([\n 'date-time',\n 'time',\n 'date',\n 'duration',\n 'email',\n 'hostname',\n 'ipv4',\n 'ipv6',\n 'uuid',\n])\n\n/**\n * Recursively drop JSON-Schema `format` keywords whose value isn't in OpenAI's\n * strict-mode allowlist. Pure — returns a fresh tree and never mutates `node`,\n * so the caller's original tool definition is left intact.\n *\n * A property *named* `format` always has a schema (object/boolean) value, never\n * a bare string, so it is preserved and recursed into; only the `format`\n * *keyword* (whose value is a string) is subject to removal.\n */\nexport function stripUnsupportedFormats(node: any): any {\n if (Array.isArray(node)) return node.map(stripUnsupportedFormats)\n if (node === null || typeof node !== 'object') return node\n\n const out: Record<string, any> = {}\n for (const [key, value] of Object.entries(node)) {\n if (\n key === 'format' &&\n typeof value === 'string' &&\n !SUPPORTED_STRING_FORMATS.has(value)\n ) {\n continue\n }\n out[key] = stripUnsupportedFormats(value)\n }\n return out\n}\n\n/**\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 * - String `format` keywords must be from a fixed allowlist (others are stripped)\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 return stripUnsupportedFormats(coerceStrictSchema(schema, originalRequired))\n}\n\n/**\n * JSON-Schema keywords outside OpenAI's strict Structured Outputs subset. A\n * schema using any of these can't be coerced into a strict-valid shape, and\n * sending it with `strict: true` makes the API reject the ENTIRE request\n * (e.g. `400 Invalid schema ... 'additionalProperties' is required to be ...`).\n * Tools with such schemas are emitted with `strict: false` instead (see the\n * tool converters) so they remain callable. MCP servers (e.g. Notion) routinely\n * emit these.\n *\n * - `oneOf` / `allOf` / `not` — combinator keywords strict mode rejects\n * - `$ref` / `$defs` / `definitions` — references and definition pools whose\n * object subschemas escape the `additionalProperties: false` normalization\n * strict mode requires\n */\nconst STRICT_UNSUPPORTED_KEYWORDS: ReadonlyArray<string> = [\n 'oneOf',\n 'allOf',\n 'not',\n '$ref',\n '$defs',\n 'definitions',\n]\n\n/**\n * Returns `false` when `schema` (anywhere in the tree) uses a JSON-Schema\n * keyword outside OpenAI's strict Structured Outputs subset — i.e. it cannot be\n * made strict-compatible and must be sent with `strict: false`.\n *\n * Conservative by design: keywords are matched as object keys, so a property\n * literally named e.g. `oneOf` also trips it. That only costs that one tool its\n * strict mode, which is strictly safer than a false \"compatible\" verdict that\n * 400s the whole request.\n */\nexport function isStrictModeCompatible(schema: unknown): boolean {\n return !containsStrictUnsupportedKeyword(schema)\n}\n\nfunction containsStrictUnsupportedKeyword(node: unknown): boolean {\n if (Array.isArray(node)) {\n return node.some(containsStrictUnsupportedKeyword)\n }\n if (node === null || typeof node !== 'object') return false\n for (const [key, value] of Object.entries(node)) {\n if (STRICT_UNSUPPORTED_KEYWORDS.includes(key)) return true\n if (containsStrictUnsupportedKeyword(value)) return true\n }\n return false\n}\n\n/**\n * Strict-mode structural rewrite (required widening, nullability,\n * additionalProperties). Kept private so the public entry point can apply the\n * format-stripping pass exactly once over the fully-rewritten tree.\n */\nfunction coerceStrictSchema(\n schema: Record<string, any>,\n originalRequired?: Array<string>,\n): Record<string, any> {\n const result = { ...schema }\n const required =\n originalRequired ??\n (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 = coerceStrictSchema(prop, prop.required || [])\n } else if (prop.type === 'array' && prop.items) {\n prop = {\n ...prop,\n items: coerceStrictSchema(prop.items, prop.items.required || []),\n }\n } else if (prop.anyOf) {\n prop = coerceStrictSchema(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 = coerceStrictSchema(result.items, result.items.required || [])\n }\n\n if (result.anyOf && Array.isArray(result.anyOf)) {\n result.anyOf = result.anyOf.map((variant) =>\n coerceStrictSchema(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":"AAQA,MAAM,+CAA+B,IAAI;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAWM,SAAS,wBAAwB,MAAgB;AACtD,MAAI,MAAM,QAAQ,IAAI,EAAG,QAAO,KAAK,IAAI,uBAAuB;AAChE,MAAI,SAAS,QAAQ,OAAO,SAAS,SAAU,QAAO;AAEtD,QAAM,MAA2B,CAAA;AACjC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,IAAI,GAAG;AAC/C,QACE,QAAQ,YACR,OAAO,UAAU,YACjB,CAAC,yBAAyB,IAAI,KAAK,GACnC;AACA;AAAA,IACF;AACA,QAAI,GAAG,IAAI,wBAAwB,KAAK;AAAA,EAC1C;AACA,SAAO;AACT;AAcO,SAAS,+BACd,QACA,kBACqB;AACrB,SAAO,wBAAwB,mBAAmB,QAAQ,gBAAgB,CAAC;AAC7E;AAgBA,MAAM,8BAAqD;AAAA,EACzD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAYO,SAAS,uBAAuB,QAA0B;AAC/D,SAAO,CAAC,iCAAiC,MAAM;AACjD;AAEA,SAAS,iCAAiC,MAAwB;AAChE,MAAI,MAAM,QAAQ,IAAI,GAAG;AACvB,WAAO,KAAK,KAAK,gCAAgC;AAAA,EACnD;AACA,MAAI,SAAS,QAAQ,OAAO,SAAS,SAAU,QAAO;AACtD,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,IAAI,GAAG;AAC/C,QAAI,4BAA4B,SAAS,GAAG,EAAG,QAAO;AACtD,QAAI,iCAAiC,KAAK,EAAG,QAAO;AAAA,EACtD;AACA,SAAO;AACT;AAOA,SAAS,mBACP,QACA,kBACqB;AACrB,QAAM,SAAS,EAAE,GAAG,OAAA;AACpB,QAAM,WACJ,qBACC,MAAM,QAAQ,OAAO,UAAU,CAAC,IAAI,OAAO,UAAU,IAAI,CAAA;AAE5D,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,mBAAmB,MAAM,KAAK,YAAY,CAAA,CAAE;AAAA,MACrD,WAAW,KAAK,SAAS,WAAW,KAAK,OAAO;AAC9C,eAAO;AAAA,UACL,GAAG;AAAA,UACH,OAAO,mBAAmB,KAAK,OAAO,KAAK,MAAM,YAAY,CAAA,CAAE;AAAA,QAAA;AAAA,MAEnE,WAAW,KAAK,OAAO;AACrB,eAAO,mBAAmB,MAAM,KAAK,YAAY,CAAA,CAAE;AAAA,MACrD,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,mBAAmB,OAAO,OAAO,OAAO,MAAM,YAAY,EAAE;AAAA,EAC7E;AAEA,MAAI,OAAO,SAAS,MAAM,QAAQ,OAAO,KAAK,GAAG;AAC/C,WAAO,QAAQ,OAAO,MAAM;AAAA,MAAI,CAAC,YAC/B,mBAAmB,SAAS,QAAQ,YAAY,CAAA,CAAE;AAAA,IAAA;AAAA,EAEtD;AAEA,MAAI,OAAO,OAAO;AAChB,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,SAAO;AACT;"}