@ai-sdk-tool/parser 2.1.2 → 2.1.4

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { LanguageModelV2FunctionTool, LanguageModelV2ToolCall, LanguageModelV2ToolResultPart, LanguageModelV2Content, LanguageModelV2StreamPart, LanguageModelV2Middleware } from '@ai-sdk/provider';
+import { LanguageModelV2FunctionTool, LanguageModelV2ToolCall, LanguageModelV2ToolResultPart, LanguageModelV2Content, LanguageModelV2StreamPart, LanguageModelV2Middleware, LanguageModelV2ProviderDefinedTool, JSONSchema7 } from '@ai-sdk/provider';
 
 /**
  * ToolCallProtocol
@@ -128,8 +128,195 @@ declare function createToolMiddleware({ protocol, toolSystemPromptTemplate, }: {
     toolSystemPromptTemplate: (tools: string) => string;
 }): LanguageModelV2Middleware;
 
+/**
+ * Dynamically generates a JSON Schema using 'if/then/else' to simulate 'oneOf' behavior
+ * for tool call validation. This is useful when the environment does not support 'oneOf' directly.
+ *
+ * The generated schema validates that the incoming data (a tool call)
+ * matches exactly one of the provided tools based on its 'name' property,
+ * and then applies the corresponding tool's 'parameters' schema to its 'arguments' property.
+ *
+ * @param tools An array of tool definitions (LanguageModelV2FunctionTool or LanguageModelV2ProviderDefinedTool).
+ * Each tool must have a unique 'name' and its 'parameters' must be a valid JSON Schema.
+ * @returns A JSONSchema7 object representing the dynamic validation logic.
+ * @throws Error if a 'provider-defined' tool is encountered, as they are not supported by this middleware.
+ */
+declare function createDynamicIfThenElseSchema(tools: (LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool)[]): JSONSchema7;
+
+/**
+ * Returns the index of the start of the searchedText in the text, or null if it
+ * is not found.
+ * ref: https://github.com/vercel/ai/blob/452bf12f0be9cb398d4af85a006bca13c8ce36d8/packages/ai/core/util/get-potential-start-index.ts
+ */
+declare function getPotentialStartIndex(text: string, searchedText: string): number | null;
+
+declare function escapeRegExp(literal: string): string;
+
+/**
+ * Options for configuring JSON parsing behavior
+ */
+type ParseOptions = {
+    /**
+     * Enable relaxed JSON syntax parsing (unquoted keys, single quotes, trailing commas, comments)
+     * @default true
+     */
+    relaxed?: boolean;
+    /**
+     * Collect parsing warnings instead of throwing immediately. Implies tolerant mode.
+     * At the end of parsing, if warnings exist, throws with warning details.
+     * @default false
+     */
+    warnings?: boolean;
+    /**
+     * Continue parsing when encountering recoverable errors, collecting warnings.
+     * In strict mode (false), throws immediately on first error.
+     * @default false
+     */
+    tolerant?: boolean;
+    /**
+     * Allow duplicate object keys in JSON.
+     * - true: Allow duplicates (uses last value, like native JSON.parse)
+     * - false: Reject duplicates with error (enforces JSON specification)
+     * @default false
+     */
+    duplicate?: boolean;
+    /**
+     * Optional reviver function to transform parsed values (same as JSON.parse reviver)
+     * @param key - The object key or array index
+     * @param value - The parsed value
+     * @returns The transformed value
+     */
+    reviver?: (key: string, value: unknown) => unknown;
+};
+/**
+ * Transform relaxed JSON syntax to standard JSON string
+ *
+ * Converts relaxed JSON features (unquoted keys, single quotes, trailing commas, comments)
+ * into valid standard JSON syntax that can be parsed by native JSON.parse().
+ *
+ * @param text - The relaxed JSON string to transform
+ * @returns A standard JSON string
+ *
+ * @example
+ * ```typescript
+ * transform('{key: "value", trailing: "comma",}')
+ * // Returns: '{"key": "value", "trailing": "comma"}'
+ *
+ * transform("{'single': 'quotes'}")
+ * // Returns: '{"single": "quotes"}'
+ * ```
+ */
+declare function transform(text: string): string;
+/**
+ * Parse a JSON string with enhanced features beyond standard JSON.parse()
+ *
+ * Supports both strict JSON and relaxed JSON syntax with configurable error handling
+ * and duplicate key validation.
+ *
+ * @param text - The JSON string to parse
+ * @param optsOrReviver - Either a ParseOptions object for configuration, or a reviver function (like JSON.parse)
+ *
+ * @returns The parsed JavaScript value
+ *
+ * @throws {SyntaxError} When parsing fails in strict mode, or when warnings are collected in tolerant mode
+ *
+ * @example
+ * ```typescript
+ * // Standard JSON parsing
+ * parse('{"key": "value"}')
+ *
+ * // Relaxed JSON with unquoted keys and trailing commas
+ * parse('{key: "value", trailing: "comma",}', { relaxed: true })
+ *
+ * // Strict duplicate key validation
+ * parse('{"key": 1, "key": 2}', { duplicate: false }) // throws error
+ *
+ * // Allow duplicates (uses last value)
+ * parse('{"key": 1, "key": 2}', { duplicate: true }) // returns {key: 2}
+ *
+ * // Tolerant mode with warning collection
+ * parse('malformed json', { tolerant: true, warnings: true })
+ * ```
+ */
+declare function parse(text: string, optsOrReviver?: ParseOptions | ((key: string, value: unknown) => unknown)): unknown;
+/**
+ * Convert JavaScript value to JSON string with sorted object keys
+ *
+ * Similar to JSON.stringify but with consistent key ordering (sorted alphabetically).
+ * Handles undefined values by converting them to null.
+ *
+ * @param obj - The value to convert to JSON string
+ * @returns A JSON string representation
+ *
+ * @example
+ * ```typescript
+ * stringify({z: 1, a: 2, m: 3})
+ * // Returns: '{"a":2,"m":3,"z":1}' (keys sorted)
+ *
+ * stringify({key: undefined})
+ * // Returns: '{"key":null}' (undefined becomes null)
+ * ```
+ */
+declare function stringify(obj: unknown): string;
+
+type robustJson_ParseOptions = ParseOptions;
+declare const robustJson_parse: typeof parse;
+declare const robustJson_stringify: typeof stringify;
+declare const robustJson_transform: typeof transform;
+declare namespace robustJson {
+  export { type robustJson_ParseOptions as ParseOptions, robustJson_parse as parse, robustJson_stringify as stringify, robustJson_transform as transform };
+}
+
+declare function unwrapJsonSchema(schema: unknown): unknown;
+declare function getSchemaType(schema: unknown): string | undefined;
+declare function coerceBySchema(value: unknown, schema?: unknown): unknown;
+declare function fixToolCallWithSchema(part: LanguageModelV2Content, tools: Array<{
+    name?: string;
+    inputSchema?: unknown;
+}>): LanguageModelV2Content;
+declare function coerceToolCallInput(part: LanguageModelV2Content, tools: Array<{
+    name?: string;
+    inputSchema?: unknown;
+}>): LanguageModelV2Content;
+
+type DebugLevel = "off" | "stream" | "parse";
+declare function getDebugLevel(): DebugLevel;
+declare function logRawChunk(part: unknown): void;
+declare function logParsedChunk(part: unknown): void;
+declare function logParsedSummary({ toolCalls, originalText, }: {
+    toolCalls: unknown[];
+    originalText: string;
+}): void;
+
+type OnErrorFn = (message: string, metadata?: Record<string, unknown>) => void;
+declare function extractOnErrorOption(providerOptions?: unknown): {
+    onError?: OnErrorFn;
+} | undefined;
+
+declare function isToolChoiceActive(params: {
+    providerOptions?: {
+        toolCallMiddleware?: {
+            toolChoice?: {
+                type: string;
+            };
+        };
+    };
+}): boolean;
+declare function getFunctionTools(params: {
+    tools?: Array<LanguageModelV2FunctionTool | {
+        type: string;
+    }>;
+    providerOptions?: unknown;
+}): LanguageModelV2FunctionTool[];
+
+declare function isToolCallContent(content: unknown): content is LanguageModelV2ToolCall;
+declare function isToolResultPart(content: unknown): content is LanguageModelV2ToolResultPart;
+declare function hasInputProperty(obj: unknown): obj is {
+    input?: unknown;
+};
+
 declare const gemmaToolMiddleware: _ai_sdk_provider.LanguageModelV2Middleware;
 declare const hermesToolMiddleware: _ai_sdk_provider.LanguageModelV2Middleware;
 declare const xmlToolMiddleware: _ai_sdk_provider.LanguageModelV2Middleware;
 
-export { createToolMiddleware, gemmaToolMiddleware, hermesToolMiddleware, jsonMixProtocol, morphXmlProtocol, xmlToolMiddleware };
+export { type DebugLevel, type OnErrorFn, robustJson as RJSON, coerceBySchema, coerceToolCallInput, createDynamicIfThenElseSchema, createToolMiddleware, escapeRegExp, extractOnErrorOption, fixToolCallWithSchema, gemmaToolMiddleware, getDebugLevel, getFunctionTools, getPotentialStartIndex, getSchemaType, hasInputProperty, hermesToolMiddleware, isToolCallContent, isToolChoiceActive, isToolResultPart, jsonMixProtocol, logParsedChunk, logParsedSummary, logRawChunk, morphXmlProtocol, unwrapJsonSchema, xmlToolMiddleware };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { LanguageModelV2FunctionTool, LanguageModelV2ToolCall, LanguageModelV2ToolResultPart, LanguageModelV2Content, LanguageModelV2StreamPart, LanguageModelV2Middleware } from '@ai-sdk/provider';
+import { LanguageModelV2FunctionTool, LanguageModelV2ToolCall, LanguageModelV2ToolResultPart, LanguageModelV2Content, LanguageModelV2StreamPart, LanguageModelV2Middleware, LanguageModelV2ProviderDefinedTool, JSONSchema7 } from '@ai-sdk/provider';
 
 /**
  * ToolCallProtocol
@@ -128,8 +128,195 @@ declare function createToolMiddleware({ protocol, toolSystemPromptTemplate, }: {
     toolSystemPromptTemplate: (tools: string) => string;
 }): LanguageModelV2Middleware;
 
+/**
+ * Dynamically generates a JSON Schema using 'if/then/else' to simulate 'oneOf' behavior
+ * for tool call validation. This is useful when the environment does not support 'oneOf' directly.
+ *
+ * The generated schema validates that the incoming data (a tool call)
+ * matches exactly one of the provided tools based on its 'name' property,
+ * and then applies the corresponding tool's 'parameters' schema to its 'arguments' property.
+ *
+ * @param tools An array of tool definitions (LanguageModelV2FunctionTool or LanguageModelV2ProviderDefinedTool).
+ * Each tool must have a unique 'name' and its 'parameters' must be a valid JSON Schema.
+ * @returns A JSONSchema7 object representing the dynamic validation logic.
+ * @throws Error if a 'provider-defined' tool is encountered, as they are not supported by this middleware.
+ */
+declare function createDynamicIfThenElseSchema(tools: (LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool)[]): JSONSchema7;
+
+/**
+ * Returns the index of the start of the searchedText in the text, or null if it
+ * is not found.
+ * ref: https://github.com/vercel/ai/blob/452bf12f0be9cb398d4af85a006bca13c8ce36d8/packages/ai/core/util/get-potential-start-index.ts
+ */
+declare function getPotentialStartIndex(text: string, searchedText: string): number | null;
+
+declare function escapeRegExp(literal: string): string;
+
+/**
+ * Options for configuring JSON parsing behavior
+ */
+type ParseOptions = {
+    /**
+     * Enable relaxed JSON syntax parsing (unquoted keys, single quotes, trailing commas, comments)
+     * @default true
+     */
+    relaxed?: boolean;
+    /**
+     * Collect parsing warnings instead of throwing immediately. Implies tolerant mode.
+     * At the end of parsing, if warnings exist, throws with warning details.
+     * @default false
+     */
+    warnings?: boolean;
+    /**
+     * Continue parsing when encountering recoverable errors, collecting warnings.
+     * In strict mode (false), throws immediately on first error.
+     * @default false
+     */
+    tolerant?: boolean;
+    /**
+     * Allow duplicate object keys in JSON.
+     * - true: Allow duplicates (uses last value, like native JSON.parse)
+     * - false: Reject duplicates with error (enforces JSON specification)
+     * @default false
+     */
+    duplicate?: boolean;
+    /**
+     * Optional reviver function to transform parsed values (same as JSON.parse reviver)
+     * @param key - The object key or array index
+     * @param value - The parsed value
+     * @returns The transformed value
+     */
+    reviver?: (key: string, value: unknown) => unknown;
+};
+/**
+ * Transform relaxed JSON syntax to standard JSON string
+ *
+ * Converts relaxed JSON features (unquoted keys, single quotes, trailing commas, comments)
+ * into valid standard JSON syntax that can be parsed by native JSON.parse().
+ *
+ * @param text - The relaxed JSON string to transform
+ * @returns A standard JSON string
+ *
+ * @example
+ * ```typescript
+ * transform('{key: "value", trailing: "comma",}')
+ * // Returns: '{"key": "value", "trailing": "comma"}'
+ *
+ * transform("{'single': 'quotes'}")
+ * // Returns: '{"single": "quotes"}'
+ * ```
+ */
+declare function transform(text: string): string;
+/**
+ * Parse a JSON string with enhanced features beyond standard JSON.parse()
+ *
+ * Supports both strict JSON and relaxed JSON syntax with configurable error handling
+ * and duplicate key validation.
+ *
+ * @param text - The JSON string to parse
+ * @param optsOrReviver - Either a ParseOptions object for configuration, or a reviver function (like JSON.parse)
+ *
+ * @returns The parsed JavaScript value
+ *
+ * @throws {SyntaxError} When parsing fails in strict mode, or when warnings are collected in tolerant mode
+ *
+ * @example
+ * ```typescript
+ * // Standard JSON parsing
+ * parse('{"key": "value"}')
+ *
+ * // Relaxed JSON with unquoted keys and trailing commas
+ * parse('{key: "value", trailing: "comma",}', { relaxed: true })
+ *
+ * // Strict duplicate key validation
+ * parse('{"key": 1, "key": 2}', { duplicate: false }) // throws error
+ *
+ * // Allow duplicates (uses last value)
+ * parse('{"key": 1, "key": 2}', { duplicate: true }) // returns {key: 2}
+ *
+ * // Tolerant mode with warning collection
+ * parse('malformed json', { tolerant: true, warnings: true })
+ * ```
+ */
+declare function parse(text: string, optsOrReviver?: ParseOptions | ((key: string, value: unknown) => unknown)): unknown;
+/**
+ * Convert JavaScript value to JSON string with sorted object keys
+ *
+ * Similar to JSON.stringify but with consistent key ordering (sorted alphabetically).
+ * Handles undefined values by converting them to null.
+ *
+ * @param obj - The value to convert to JSON string
+ * @returns A JSON string representation
+ *
+ * @example
+ * ```typescript
+ * stringify({z: 1, a: 2, m: 3})
+ * // Returns: '{"a":2,"m":3,"z":1}' (keys sorted)
+ *
+ * stringify({key: undefined})
+ * // Returns: '{"key":null}' (undefined becomes null)
+ * ```
+ */
+declare function stringify(obj: unknown): string;
+
+type robustJson_ParseOptions = ParseOptions;
+declare const robustJson_parse: typeof parse;
+declare const robustJson_stringify: typeof stringify;
+declare const robustJson_transform: typeof transform;
+declare namespace robustJson {
+  export { type robustJson_ParseOptions as ParseOptions, robustJson_parse as parse, robustJson_stringify as stringify, robustJson_transform as transform };
+}
+
+declare function unwrapJsonSchema(schema: unknown): unknown;
+declare function getSchemaType(schema: unknown): string | undefined;
+declare function coerceBySchema(value: unknown, schema?: unknown): unknown;
+declare function fixToolCallWithSchema(part: LanguageModelV2Content, tools: Array<{
+    name?: string;
+    inputSchema?: unknown;
+}>): LanguageModelV2Content;
+declare function coerceToolCallInput(part: LanguageModelV2Content, tools: Array<{
+    name?: string;
+    inputSchema?: unknown;
+}>): LanguageModelV2Content;
+
+type DebugLevel = "off" | "stream" | "parse";
+declare function getDebugLevel(): DebugLevel;
+declare function logRawChunk(part: unknown): void;
+declare function logParsedChunk(part: unknown): void;
+declare function logParsedSummary({ toolCalls, originalText, }: {
+    toolCalls: unknown[];
+    originalText: string;
+}): void;
+
+type OnErrorFn = (message: string, metadata?: Record<string, unknown>) => void;
+declare function extractOnErrorOption(providerOptions?: unknown): {
+    onError?: OnErrorFn;
+} | undefined;
+
+declare function isToolChoiceActive(params: {
+    providerOptions?: {
+        toolCallMiddleware?: {
+            toolChoice?: {
+                type: string;
+            };
+        };
+    };
+}): boolean;
+declare function getFunctionTools(params: {
+    tools?: Array<LanguageModelV2FunctionTool | {
+        type: string;
+    }>;
+    providerOptions?: unknown;
+}): LanguageModelV2FunctionTool[];
+
+declare function isToolCallContent(content: unknown): content is LanguageModelV2ToolCall;
+declare function isToolResultPart(content: unknown): content is LanguageModelV2ToolResultPart;
+declare function hasInputProperty(obj: unknown): obj is {
+    input?: unknown;
+};
+
 declare const gemmaToolMiddleware: _ai_sdk_provider.LanguageModelV2Middleware;
 declare const hermesToolMiddleware: _ai_sdk_provider.LanguageModelV2Middleware;
 declare const xmlToolMiddleware: _ai_sdk_provider.LanguageModelV2Middleware;
 
-export { createToolMiddleware, gemmaToolMiddleware, hermesToolMiddleware, jsonMixProtocol, morphXmlProtocol, xmlToolMiddleware };
+export { type DebugLevel, type OnErrorFn, robustJson as RJSON, coerceBySchema, coerceToolCallInput, createDynamicIfThenElseSchema, createToolMiddleware, escapeRegExp, extractOnErrorOption, fixToolCallWithSchema, gemmaToolMiddleware, getDebugLevel, getFunctionTools, getPotentialStartIndex, getSchemaType, hasInputProperty, hermesToolMiddleware, isToolCallContent, isToolChoiceActive, isToolResultPart, jsonMixProtocol, logParsedChunk, logParsedSummary, logRawChunk, morphXmlProtocol, unwrapJsonSchema, xmlToolMiddleware };