@mastra/tavily 1.1.1 → 1.1.2-alpha.0

package/dist/index.js

@@ -1,280 +1,277 @@
-import { tavily } from '@tavily/core';
-import { createTool } from '@mastra/core/tools';
-import { z } from 'zod';
-
-// src/client.ts
+import { tavily } from "@tavily/core";
+import { createTool } from "@mastra/core/tools";
+import { z } from "zod";
+//#region src/client.ts
 function getTavilyClient(config) {
-  const apiKey = config?.apiKey ?? process.env.TAVILY_API_KEY;
-  if (!apiKey) {
-    throw new Error("Tavily API key is required. Pass { apiKey } or set TAVILY_API_KEY env var.");
-  }
-  return tavily({ ...config, apiKey, clientName: config?.clientName ?? "mastra" });
+	const apiKey = config?.apiKey ?? process.env.TAVILY_API_KEY;
+	if (!apiKey) throw new Error("Tavily API key is required. Pass { apiKey } or set TAVILY_API_KEY env var.");
+	return tavily({
+		...config,
+		apiKey,
+		clientName: config?.clientName ?? "mastra"
+	});
 }
-var inputSchema = z.object({
-  query: z.string().describe("The search query"),
-  searchDepth: z.enum(["basic", "advanced", "fast", "ultra-fast"]).optional().describe("Search depth \u2014 'basic' for standard, 'advanced' for thorough, 'fast'/'ultra-fast' for low latency"),
-  maxResults: z.number().min(1).max(20).optional().describe("Maximum number of results to return (1-20)"),
-  includeAnswer: z.union([z.boolean(), z.enum(["basic", "advanced"])]).optional().describe('Include an AI-generated answer summary. Pass true, "basic", or "advanced"'),
-  includeImages: z.boolean().optional().describe("Include query-related images in the response"),
-  includeImageDescriptions: z.boolean().optional().describe("Include descriptions for returned images"),
-  includeRawContent: z.union([z.literal(false), z.enum(["markdown", "text"])]).optional().describe('Include cleaned HTML content of each result. Pass false to disable, or "markdown"/"text" for format'),
-  includeDomains: z.array(z.string()).optional().describe("Restrict results to these domains"),
-  excludeDomains: z.array(z.string()).optional().describe("Exclude results from these domains"),
-  timeRange: z.enum(["day", "week", "month", "year"]).optional().describe("Time range to filter results by recency")
+//#endregion
+//#region src/search.ts
+const inputSchema$3 = z.object({
+	query: z.string().describe("The search query"),
+	searchDepth: z.enum([
+		"basic",
+		"advanced",
+		"fast",
+		"ultra-fast"
+	]).optional().describe("Search depth — 'basic' for standard, 'advanced' for thorough, 'fast'/'ultra-fast' for low latency"),
+	maxResults: z.number().min(1).max(20).optional().describe("Maximum number of results to return (1-20)"),
+	includeAnswer: z.union([z.boolean(), z.enum(["basic", "advanced"])]).optional().describe("Include an AI-generated answer summary. Pass true, \"basic\", or \"advanced\""),
+	includeImages: z.boolean().optional().describe("Include query-related images in the response"),
+	includeImageDescriptions: z.boolean().optional().describe("Include descriptions for returned images"),
+	includeRawContent: z.union([z.literal(false), z.enum(["markdown", "text"])]).optional().describe("Include cleaned HTML content of each result. Pass false to disable, or \"markdown\"/\"text\" for format"),
+	includeDomains: z.array(z.string()).optional().describe("Restrict results to these domains"),
+	excludeDomains: z.array(z.string()).optional().describe("Exclude results from these domains"),
+	timeRange: z.enum([
+		"day",
+		"week",
+		"month",
+		"year"
+	]).optional().describe("Time range to filter results by recency")
 });
-var outputSchema = z.object({
-  query: z.string(),
-  answer: z.string().optional(),
-  images: z.array(
-    z.object({
-      url: z.string(),
-      description: z.string().optional()
-    })
-  ).optional(),
-  results: z.array(
-    z.object({
-      title: z.string(),
-      url: z.string(),
-      content: z.string(),
-      score: z.number(),
-      rawContent: z.string().optional()
-    })
-  ),
-  responseTime: z.number()
+const outputSchema$3 = z.object({
+	query: z.string(),
+	answer: z.string().optional(),
+	images: z.array(z.object({
+		url: z.string(),
+		description: z.string().optional()
+	})).optional(),
+	results: z.array(z.object({
+		title: z.string(),
+		url: z.string(),
+		content: z.string(),
+		score: z.number(),
+		rawContent: z.string().optional()
+	})),
+	responseTime: z.number()
 });
 function createTavilySearchTool(config) {
-  let client = null;
-  function getClient() {
-    if (!client) {
-      client = getTavilyClient(config);
-    }
-    return client;
-  }
-  return createTool({
-    id: "tavily-search",
-    description: "Search the web using Tavily. Returns relevant results with content snippets, optional AI-generated answers, and images. Supports filtering by domain, time range, and search depth.",
-    inputSchema,
-    outputSchema,
-    execute: async (input) => {
-      const tavilyClient = getClient();
-      const response = await tavilyClient.search(input.query, {
-        searchDepth: input.searchDepth,
-        maxResults: input.maxResults,
-        includeAnswer: input.includeAnswer,
-        includeImages: input.includeImages,
-        includeImageDescriptions: input.includeImageDescriptions,
-        includeRawContent: input.includeRawContent,
-        includeDomains: input.includeDomains,
-        excludeDomains: input.excludeDomains,
-        timeRange: input.timeRange
-      });
-      return {
-        query: response.query,
-        answer: response.answer || void 0,
-        images: response.images?.map((img) => ({
-          url: typeof img === "string" ? img : img.url,
-          description: typeof img === "string" ? void 0 : img.description
-        })),
-        results: (response.results ?? []).map((r) => ({
-          title: r.title,
-          url: r.url,
-          content: r.content,
-          score: r.score ?? 0,
-          rawContent: r.rawContent || void 0
-        })),
-        responseTime: response.responseTime
-      };
-    }
-  });
+	let client = null;
+	function getClient() {
+		if (!client) client = getTavilyClient(config);
+		return client;
+	}
+	return createTool({
+		id: "tavily-search",
+		description: "Search the web using Tavily. Returns relevant results with content snippets, optional AI-generated answers, and images. Supports filtering by domain, time range, and search depth.",
+		inputSchema: inputSchema$3,
+		outputSchema: outputSchema$3,
+		execute: async (input) => {
+			const response = await getClient().search(input.query, {
+				searchDepth: input.searchDepth,
+				maxResults: input.maxResults,
+				includeAnswer: input.includeAnswer,
+				includeImages: input.includeImages,
+				includeImageDescriptions: input.includeImageDescriptions,
+				includeRawContent: input.includeRawContent,
+				includeDomains: input.includeDomains,
+				excludeDomains: input.excludeDomains,
+				timeRange: input.timeRange
+			});
+			return {
+				query: response.query,
+				answer: response.answer || void 0,
+				images: response.images?.map((img) => ({
+					url: typeof img === "string" ? img : img.url,
+					description: typeof img === "string" ? void 0 : img.description
+				})),
+				results: (response.results ?? []).map((r) => ({
+					title: r.title,
+					url: r.url,
+					content: r.content,
+					score: r.score ?? 0,
+					rawContent: r.rawContent || void 0
+				})),
+				responseTime: response.responseTime
+			};
+		}
+	});
 }
-var inputSchema2 = z.object({
-  urls: z.array(z.string()).min(1).max(20).describe("URLs to extract content from (1-20)"),
-  extractDepth: z.enum(["basic", "advanced"]).optional().describe("Extraction depth \u2014 'advanced' retrieves more data including tables and embedded content"),
-  query: z.string().optional().describe("User intent for reranking extracted content chunks. When provided, chunks are reranked based on relevance to this query."),
-  includeImages: z.boolean().optional().describe("Include images extracted from the pages"),
-  format: z.enum(["markdown", "text"]).optional().describe("Output format for extracted content \u2014 'markdown' (default) or 'text'")
+//#endregion
+//#region src/extract.ts
+const inputSchema$2 = z.object({
+	urls: z.array(z.string()).min(1).max(20).describe("URLs to extract content from (1-20)"),
+	extractDepth: z.enum(["basic", "advanced"]).optional().describe("Extraction depth — 'advanced' retrieves more data including tables and embedded content"),
+	query: z.string().optional().describe("User intent for reranking extracted content chunks. When provided, chunks are reranked based on relevance to this query."),
+	includeImages: z.boolean().optional().describe("Include images extracted from the pages"),
+	format: z.enum(["markdown", "text"]).optional().describe("Output format for extracted content — 'markdown' (default) or 'text'")
 });
-var outputSchema2 = z.object({
-  results: z.array(
-    z.object({
-      url: z.string(),
-      rawContent: z.string(),
-      images: z.array(z.string()).optional()
-    })
-  ),
-  failedResults: z.array(
-    z.object({
-      url: z.string(),
-      error: z.string()
-    })
-  ),
-  responseTime: z.number()
+const outputSchema$2 = z.object({
+	results: z.array(z.object({
+		url: z.string(),
+		rawContent: z.string(),
+		images: z.array(z.string()).optional()
+	})),
+	failedResults: z.array(z.object({
+		url: z.string(),
+		error: z.string()
+	})),
+	responseTime: z.number()
 });
 function createTavilyExtractTool(config) {
-  let client = null;
-  function getClient() {
-    if (!client) {
-      client = getTavilyClient(config);
-    }
-    return client;
-  }
-  return createTool({
-    id: "tavily-extract",
-    description: "Extract content from one or more URLs using Tavily. Returns raw page content in markdown or text format. Supports up to 20 URLs per request with basic or advanced extraction depth.",
-    inputSchema: inputSchema2,
-    outputSchema: outputSchema2,
-    execute: async (input) => {
-      const tavilyClient = getClient();
-      const response = await tavilyClient.extract(input.urls, {
-        extractDepth: input.extractDepth,
-        query: input.query,
-        includeImages: input.includeImages,
-        format: input.format
-      });
-      return {
-        results: (response.results || []).map((r) => ({
-          url: r.url,
-          rawContent: r.rawContent,
-          images: r.images || void 0
-        })),
-        failedResults: (response.failedResults || []).map((r) => ({
-          url: r.url,
-          error: r.error
-        })),
-        responseTime: response.responseTime
-      };
-    }
-  });
+	let client = null;
+	function getClient() {
+		if (!client) client = getTavilyClient(config);
+		return client;
+	}
+	return createTool({
+		id: "tavily-extract",
+		description: "Extract content from one or more URLs using Tavily. Returns raw page content in markdown or text format. Supports up to 20 URLs per request with basic or advanced extraction depth.",
+		inputSchema: inputSchema$2,
+		outputSchema: outputSchema$2,
+		execute: async (input) => {
+			const response = await getClient().extract(input.urls, {
+				extractDepth: input.extractDepth,
+				query: input.query,
+				includeImages: input.includeImages,
+				format: input.format
+			});
+			return {
+				results: (response.results || []).map((r) => ({
+					url: r.url,
+					rawContent: r.rawContent,
+					images: r.images || void 0
+				})),
+				failedResults: (response.failedResults || []).map((r) => ({
+					url: r.url,
+					error: r.error
+				})),
+				responseTime: response.responseTime
+			};
+		}
+	});
 }
-var inputSchema3 = z.object({
-  url: z.string().describe("The root URL to begin the crawl"),
-  maxDepth: z.number().optional().describe("Max depth of the crawl from the base URL"),
-  maxBreadth: z.number().optional().describe("Max number of links to follow per page"),
-  limit: z.number().optional().describe("Total number of pages the crawler will process before stopping"),
-  instructions: z.string().optional().describe("Natural language instructions for the crawler"),
-  selectPaths: z.array(z.string()).optional().describe("Regex patterns to select specific URL paths"),
-  selectDomains: z.array(z.string()).optional().describe("Regex patterns to restrict to specific domains"),
-  excludePaths: z.array(z.string()).optional().describe("Regex patterns to exclude specific URL paths"),
-  excludeDomains: z.array(z.string()).optional().describe("Regex patterns to exclude specific domains"),
-  allowExternal: z.boolean().optional().describe("Whether to follow links to external domains"),
-  extractDepth: z.enum(["basic", "advanced"]).optional().describe("Extraction depth \u2014 'advanced' retrieves more data including tables and embedded content"),
-  includeImages: z.boolean().optional().describe("Include images from crawled pages"),
-  format: z.enum(["markdown", "text"]).optional().describe("Output format for extracted content \u2014 'markdown' (default) or 'text'")
+//#endregion
+//#region src/crawl.ts
+const inputSchema$1 = z.object({
+	url: z.string().describe("The root URL to begin the crawl"),
+	maxDepth: z.number().optional().describe("Max depth of the crawl from the base URL"),
+	maxBreadth: z.number().optional().describe("Max number of links to follow per page"),
+	limit: z.number().optional().describe("Total number of pages the crawler will process before stopping"),
+	instructions: z.string().optional().describe("Natural language instructions for the crawler"),
+	selectPaths: z.array(z.string()).optional().describe("Regex patterns to select specific URL paths"),
+	selectDomains: z.array(z.string()).optional().describe("Regex patterns to restrict to specific domains"),
+	excludePaths: z.array(z.string()).optional().describe("Regex patterns to exclude specific URL paths"),
+	excludeDomains: z.array(z.string()).optional().describe("Regex patterns to exclude specific domains"),
+	allowExternal: z.boolean().optional().describe("Whether to follow links to external domains"),
+	extractDepth: z.enum(["basic", "advanced"]).optional().describe("Extraction depth — 'advanced' retrieves more data including tables and embedded content"),
+	includeImages: z.boolean().optional().describe("Include images from crawled pages"),
+	format: z.enum(["markdown", "text"]).optional().describe("Output format for extracted content — 'markdown' (default) or 'text'")
 });
-var outputSchema3 = z.object({
-  baseUrl: z.string(),
-  results: z.array(
-    z.object({
-      url: z.string(),
-      rawContent: z.string(),
-      images: z.array(z.string()).optional()
-    })
-  ),
-  responseTime: z.number()
+const outputSchema$1 = z.object({
+	baseUrl: z.string(),
+	results: z.array(z.object({
+		url: z.string(),
+		rawContent: z.string(),
+		images: z.array(z.string()).optional()
+	})),
+	responseTime: z.number()
 });
 function createTavilyCrawlTool(config) {
-  let client = null;
-  function getClient() {
-    if (!client) {
-      client = getTavilyClient(config);
-    }
-    return client;
-  }
-  return createTool({
-    id: "tavily-crawl",
-    description: "Crawl a website starting from a URL using Tavily. Extracts content from discovered pages with configurable depth, breadth, and domain constraints. Returns structured content from each crawled page.",
-    inputSchema: inputSchema3,
-    outputSchema: outputSchema3,
-    execute: async (input) => {
-      const tavilyClient = getClient();
-      const response = await tavilyClient.crawl(input.url, {
-        maxDepth: input.maxDepth,
-        maxBreadth: input.maxBreadth,
-        limit: input.limit,
-        instructions: input.instructions,
-        selectPaths: input.selectPaths,
-        selectDomains: input.selectDomains,
-        excludePaths: input.excludePaths,
-        excludeDomains: input.excludeDomains,
-        allowExternal: input.allowExternal,
-        extractDepth: input.extractDepth,
-        includeImages: input.includeImages,
-        format: input.format
-      });
-      return {
-        baseUrl: response.baseUrl,
-        results: (response.results || []).map((r) => ({
-          url: r.url,
-          rawContent: r.rawContent,
-          images: r.images || void 0
-        })),
-        responseTime: response.responseTime
-      };
-    }
-  });
+	let client = null;
+	function getClient() {
+		if (!client) client = getTavilyClient(config);
+		return client;
+	}
+	return createTool({
+		id: "tavily-crawl",
+		description: "Crawl a website starting from a URL using Tavily. Extracts content from discovered pages with configurable depth, breadth, and domain constraints. Returns structured content from each crawled page.",
+		inputSchema: inputSchema$1,
+		outputSchema: outputSchema$1,
+		execute: async (input) => {
+			const response = await getClient().crawl(input.url, {
+				maxDepth: input.maxDepth,
+				maxBreadth: input.maxBreadth,
+				limit: input.limit,
+				instructions: input.instructions,
+				selectPaths: input.selectPaths,
+				selectDomains: input.selectDomains,
+				excludePaths: input.excludePaths,
+				excludeDomains: input.excludeDomains,
+				allowExternal: input.allowExternal,
+				extractDepth: input.extractDepth,
+				includeImages: input.includeImages,
+				format: input.format
+			});
+			return {
+				baseUrl: response.baseUrl,
+				results: (response.results || []).map((r) => ({
+					url: r.url,
+					rawContent: r.rawContent,
+					images: r.images || void 0
+				})),
+				responseTime: response.responseTime
+			};
+		}
+	});
 }
-var inputSchema4 = z.object({
-  url: z.string().describe("The root URL to begin mapping"),
-  maxDepth: z.number().optional().describe("Max depth of the mapping from the base URL"),
-  maxBreadth: z.number().optional().describe("Max number of links to follow per page"),
-  limit: z.number().optional().describe("Total number of links the mapper will process before stopping"),
-  instructions: z.string().optional().describe("Natural language instructions for the mapper"),
-  selectPaths: z.array(z.string()).optional().describe("Regex patterns to select specific URL paths"),
-  selectDomains: z.array(z.string()).optional().describe("Regex patterns to restrict to specific domains"),
-  excludePaths: z.array(z.string()).optional().describe("Regex patterns to exclude specific URL paths"),
-  excludeDomains: z.array(z.string()).optional().describe("Regex patterns to exclude specific domains"),
-  allowExternal: z.boolean().optional().describe("Whether to include external domain links")
+//#endregion
+//#region src/map.ts
+const inputSchema = z.object({
+	url: z.string().describe("The root URL to begin mapping"),
+	maxDepth: z.number().optional().describe("Max depth of the mapping from the base URL"),
+	maxBreadth: z.number().optional().describe("Max number of links to follow per page"),
+	limit: z.number().optional().describe("Total number of links the mapper will process before stopping"),
+	instructions: z.string().optional().describe("Natural language instructions for the mapper"),
+	selectPaths: z.array(z.string()).optional().describe("Regex patterns to select specific URL paths"),
+	selectDomains: z.array(z.string()).optional().describe("Regex patterns to restrict to specific domains"),
+	excludePaths: z.array(z.string()).optional().describe("Regex patterns to exclude specific URL paths"),
+	excludeDomains: z.array(z.string()).optional().describe("Regex patterns to exclude specific domains"),
+	allowExternal: z.boolean().optional().describe("Whether to include external domain links")
 });
-var outputSchema4 = z.object({
-  baseUrl: z.string(),
-  results: z.array(z.string()).describe("Discovered URLs"),
-  responseTime: z.number()
+const outputSchema = z.object({
+	baseUrl: z.string(),
+	results: z.array(z.string()).describe("Discovered URLs"),
+	responseTime: z.number()
 });
 function createTavilyMapTool(config) {
-  let client = null;
-  function getClient() {
-    if (!client) {
-      client = getTavilyClient(config);
-    }
-    return client;
-  }
-  return createTool({
-    id: "tavily-map",
-    description: "Map a website's structure starting from a URL using Tavily. Discovers and returns a list of URLs found on the site without extracting page content. Useful for understanding site structure before targeted extraction.",
-    inputSchema: inputSchema4,
-    outputSchema: outputSchema4,
-    execute: async (input) => {
-      const tavilyClient = getClient();
-      const response = await tavilyClient.map(input.url, {
-        maxDepth: input.maxDepth,
-        maxBreadth: input.maxBreadth,
-        limit: input.limit,
-        instructions: input.instructions,
-        selectPaths: input.selectPaths,
-        selectDomains: input.selectDomains,
-        excludePaths: input.excludePaths,
-        excludeDomains: input.excludeDomains,
-        allowExternal: input.allowExternal
-      });
-      return {
-        baseUrl: response.baseUrl,
-        results: response.results || [],
-        responseTime: response.responseTime
-      };
-    }
-  });
+	let client = null;
+	function getClient() {
+		if (!client) client = getTavilyClient(config);
+		return client;
+	}
+	return createTool({
+		id: "tavily-map",
+		description: "Map a website's structure starting from a URL using Tavily. Discovers and returns a list of URLs found on the site without extracting page content. Useful for understanding site structure before targeted extraction.",
+		inputSchema,
+		outputSchema,
+		execute: async (input) => {
+			const response = await getClient().map(input.url, {
+				maxDepth: input.maxDepth,
+				maxBreadth: input.maxBreadth,
+				limit: input.limit,
+				instructions: input.instructions,
+				selectPaths: input.selectPaths,
+				selectDomains: input.selectDomains,
+				excludePaths: input.excludePaths,
+				excludeDomains: input.excludeDomains,
+				allowExternal: input.allowExternal
+			});
+			return {
+				baseUrl: response.baseUrl,
+				results: response.results || [],
+				responseTime: response.responseTime
+			};
+		}
+	});
 }
-
-// src/tools.ts
+//#endregion
+//#region src/tools.ts
 function createTavilyTools(config) {
-  return {
-    tavilySearch: createTavilySearchTool(config),
-    tavilyExtract: createTavilyExtractTool(config),
-    tavilyCrawl: createTavilyCrawlTool(config),
-    tavilyMap: createTavilyMapTool(config)
-  };
+	return {
+		tavilySearch: createTavilySearchTool(config),
+		tavilyExtract: createTavilyExtractTool(config),
+		tavilyCrawl: createTavilyCrawlTool(config),
+		tavilyMap: createTavilyMapTool(config)
+	};
 }
-
+//#endregion
 export { createTavilyCrawlTool, createTavilyExtractTool, createTavilyMapTool, createTavilySearchTool, createTavilyTools, getTavilyClient };
-//# sourceMappingURL=index.js.map
+
 //# sourceMappingURL=index.js.map