@scavio/ai-sdk 0.2.0

package/README.md

@@ -0,0 +1,58 @@
+# @scavio/ai-sdk
+
+Scavio search tools for the [Vercel AI SDK](https://sdk.vercel.ai). Give any AI SDK agent real-time
+search across Google, YouTube, Reddit, Amazon, Walmart, TikTok, and Instagram via the
+[Scavio](https://scavio.dev) API.
+
+## Install
+
+```bash
+npm install @scavio/ai-sdk ai
+export SCAVIO_API_KEY=sk_live_your_key
+```
+
+`ai` and `zod` are peer dependencies; `scavio` (the JS SDK) is bundled.
+
+## Usage
+
+```ts
+import { generateText, stepCountIs } from "ai";
+import { openai } from "@ai-sdk/openai";
+import { scavioSearch, scavioTools } from "@scavio/ai-sdk";
+
+// A single tool:
+const res = await generateText({
+  model: openai("gpt-4o-mini"),
+  tools: { scavio_search: scavioSearch({ maxResults: 5 }) },
+  stopWhen: stepCountIs(3),
+  prompt: "Find the official GitHub repo of the Agno framework",
+});
+
+// Or all tools at once:
+const res2 = await generateText({
+  model: openai("gpt-4o-mini"),
+  tools: scavioTools(),
+  stopWhen: stepCountIs(3),
+  prompt: "Compare prices for a mechanical keyboard on Amazon and Walmart",
+});
+```
+
+## Tools
+
+| Factory | Tool name | Provider |
+| --- | --- | --- |
+| `scavioSearch` | `scavio_search` | Google web search |
+| `scavioYoutubeSearch` | `scavio_youtube_search` | YouTube video search |
+| `scavioRedditSearch` | `scavio_reddit_search` | Reddit (2 credits) |
+| `scavioAmazonSearch` | `scavio_amazon_search` | Amazon products |
+| `scavioWalmartSearch` | `scavio_walmart_search` | Walmart products |
+| `scavioTiktokSearch` | `scavio_tiktok_search` | TikTok videos |
+| `scavioInstagramSearch` | `scavio_instagram_search` | Instagram users |
+| `scavioTools` | all of the above | bundle for `tools:` |
+
+Each factory accepts `{ apiKey?, maxResults?, ...ScavioConfig }`. The key falls back to `SCAVIO_API_KEY`.
+Get a key at [dashboard.scavio.dev](https://dashboard.scavio.dev).
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,151 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  scavioAmazonSearch: () => scavioAmazonSearch,
+  scavioInstagramSearch: () => scavioInstagramSearch,
+  scavioRedditSearch: () => scavioRedditSearch,
+  scavioSearch: () => scavioSearch,
+  scavioTiktokSearch: () => scavioTiktokSearch,
+  scavioTools: () => scavioTools,
+  scavioWalmartSearch: () => scavioWalmartSearch,
+  scavioYoutubeSearch: () => scavioYoutubeSearch
+});
+module.exports = __toCommonJS(index_exports);
+var import_ai = require("ai");
+var import_zod = require("zod");
+var import_scavio = require("scavio");
+function client(config) {
+  return new import_scavio.Scavio({ apiKey: config?.apiKey });
+}
+function trim(res, max) {
+  const results = res.results;
+  if (Array.isArray(results) && results.length > max) {
+    return { ...res, results: results.slice(0, max) };
+  }
+  return res;
+}
+function scavioSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return (0, import_ai.tool)({
+    description: "Search the web with Google via the Scavio API. Returns real-time organic search results.",
+    inputSchema: import_zod.z.object({
+      query: import_zod.z.string().describe("The search query."),
+      country_code: import_zod.z.string().optional().describe('Two-letter country code to localize results, e.g. "us".'),
+      language: import_zod.z.string().optional().describe('Two-letter language code, e.g. "en".')
+    }),
+    execute: async ({ query, country_code, language }) => trim(await c.google.search({ query, country_code, language }), max)
+  });
+}
+function scavioYoutubeSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return (0, import_ai.tool)({
+    description: "Search YouTube for videos via the Scavio API.",
+    inputSchema: import_zod.z.object({
+      query: import_zod.z.string().describe("The search query.")
+    }),
+    execute: async ({ query }) => trim(await c.youtube.search({ query }), max)
+  });
+}
+function scavioRedditSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return (0, import_ai.tool)({
+    description: "Search Reddit posts and communities via the Scavio API.",
+    inputSchema: import_zod.z.object({
+      query: import_zod.z.string().describe("The search query."),
+      sort: import_zod.z.string().optional().describe("Sort order for results.")
+    }),
+    execute: async ({ query, sort }) => trim(await c.reddit.search({ query, sort }), max)
+  });
+}
+function scavioAmazonSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return (0, import_ai.tool)({
+    description: "Search Amazon for products via the Scavio API.",
+    inputSchema: import_zod.z.object({
+      query: import_zod.z.string().describe("The product search query."),
+      domain: import_zod.z.string().optional().describe('Amazon domain, e.g. "amazon.com".')
+    }),
+    execute: async ({ query, domain }) => trim(await c.amazon.search({ query, domain }), max)
+  });
+}
+function scavioWalmartSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return (0, import_ai.tool)({
+    description: "Search Walmart for products via the Scavio API.",
+    inputSchema: import_zod.z.object({
+      query: import_zod.z.string().describe("The product search query.")
+    }),
+    execute: async ({ query }) => trim(await c.walmart.search({ query }), max)
+  });
+}
+function scavioTiktokSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return (0, import_ai.tool)({
+    description: "Search TikTok for videos by keyword via the Scavio API.",
+    inputSchema: import_zod.z.object({
+      keyword: import_zod.z.string().describe("The search keyword."),
+      sort_type: import_zod.z.string().optional().describe("Sort order for results."),
+      publish_time: import_zod.z.string().optional().describe("Filter by publish time window.")
+    }),
+    execute: async ({ keyword, sort_type, publish_time }) => trim(await c.tiktok.searchVideos({ keyword, sort_type, publish_time }), max)
+  });
+}
+function scavioInstagramSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return (0, import_ai.tool)({
+    description: "Search Instagram for users by keyword via the Scavio API.",
+    inputSchema: import_zod.z.object({
+      keyword: import_zod.z.string().describe("The search keyword.")
+    }),
+    execute: async ({ keyword }) => trim(await c.instagram.searchUsers({ keyword }), max)
+  });
+}
+function scavioTools(config) {
+  return {
+    scavio_search: scavioSearch(config),
+    scavio_youtube_search: scavioYoutubeSearch(config),
+    scavio_reddit_search: scavioRedditSearch(config),
+    scavio_amazon_search: scavioAmazonSearch(config),
+    scavio_walmart_search: scavioWalmartSearch(config),
+    scavio_tiktok_search: scavioTiktokSearch(config),
+    scavio_instagram_search: scavioInstagramSearch(config)
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  scavioAmazonSearch,
+  scavioInstagramSearch,
+  scavioRedditSearch,
+  scavioSearch,
+  scavioTiktokSearch,
+  scavioTools,
+  scavioWalmartSearch,
+  scavioYoutubeSearch
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { tool } from \"ai\";\nimport { z } from \"zod\";\nimport { Scavio, type ScavioConfig } from \"scavio\";\n\nexport interface ScavioToolConfig extends ScavioConfig {\n  /** Max number of results to keep in `results`-style lists. Defaults to 10. */\n  maxResults?: number;\n}\n\nfunction client(config?: ScavioToolConfig): Scavio {\n  return new Scavio({ apiKey: config?.apiKey });\n}\n\nfunction trim(res: Record<string, unknown>, max: number): Record<string, unknown> {\n  const results = res.results;\n  if (Array.isArray(results) && results.length > max) {\n    return { ...res, results: results.slice(0, max) };\n  }\n  return res;\n}\n\n/** Google web search. */\nexport function scavioSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description:\n      \"Search the web with Google via the Scavio API. Returns real-time organic search results.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The search query.\"),\n      country_code: z.string().optional().describe('Two-letter country code to localize results, e.g. \"us\".'),\n      language: z.string().optional().describe('Two-letter language code, e.g. \"en\".'),\n    }),\n    execute: async ({ query, country_code, language }) =>\n      trim(await c.google.search({ query, country_code, language }), max),\n  });\n}\n\n/** YouTube video search. */\nexport function scavioYoutubeSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search YouTube for videos via the Scavio API.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The search query.\"),\n    }),\n    execute: async ({ query }) => trim(await c.youtube.search({ query }), max),\n  });\n}\n\n/** Reddit post/community search (costs 2 credits). */\nexport function scavioRedditSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search Reddit posts and communities via the Scavio API.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The search query.\"),\n      sort: z.string().optional().describe(\"Sort order for results.\"),\n    }),\n    execute: async ({ query, sort }) => trim(await c.reddit.search({ query, sort }), max),\n  });\n}\n\n/** Amazon product search. */\nexport function scavioAmazonSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search Amazon for products via the Scavio API.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The product search query.\"),\n      domain: z.string().optional().describe('Amazon domain, e.g. \"amazon.com\".'),\n    }),\n    execute: async ({ query, domain }) => trim(await c.amazon.search({ query, domain }), max),\n  });\n}\n\n/** Walmart product search. */\nexport function scavioWalmartSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search Walmart for products via the Scavio API.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The product search query.\"),\n    }),\n    execute: async ({ query }) => trim(await c.walmart.search({ query }), max),\n  });\n}\n\n/** TikTok video search. */\nexport function scavioTiktokSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search TikTok for videos by keyword via the Scavio API.\",\n    inputSchema: z.object({\n      keyword: z.string().describe(\"The search keyword.\"),\n      sort_type: z.string().optional().describe(\"Sort order for results.\"),\n      publish_time: z.string().optional().describe(\"Filter by publish time window.\"),\n    }),\n    execute: async ({ keyword, sort_type, publish_time }) =>\n      trim(await c.tiktok.searchVideos({ keyword, sort_type, publish_time }), max),\n  });\n}\n\n/** Instagram user search. */\nexport function scavioInstagramSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search Instagram for users by keyword via the Scavio API.\",\n    inputSchema: z.object({\n      keyword: z.string().describe(\"The search keyword.\"),\n    }),\n    execute: async ({ keyword }) => trim(await c.instagram.searchUsers({ keyword }), max),\n  });\n}\n\n/**\n * All Scavio tools as an object keyed by tool name, ready to spread into the\n * `tools` option of `generateText` / `streamText`.\n */\nexport function scavioTools(config?: ScavioToolConfig) {\n  return {\n    scavio_search: scavioSearch(config),\n    scavio_youtube_search: scavioYoutubeSearch(config),\n    scavio_reddit_search: scavioRedditSearch(config),\n    scavio_amazon_search: scavioAmazonSearch(config),\n    scavio_walmart_search: scavioWalmartSearch(config),\n    scavio_tiktok_search: scavioTiktokSearch(config),\n    scavio_instagram_search: scavioInstagramSearch(config),\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAAqB;AACrB,iBAAkB;AAClB,oBAA0C;AAO1C,SAAS,OAAO,QAAmC;AACjD,SAAO,IAAI,qBAAO,EAAE,QAAQ,QAAQ,OAAO,CAAC;AAC9C;AAEA,SAAS,KAAK,KAA8B,KAAsC;AAChF,QAAM,UAAU,IAAI;AACpB,MAAI,MAAM,QAAQ,OAAO,KAAK,QAAQ,SAAS,KAAK;AAClD,WAAO,EAAE,GAAG,KAAK,SAAS,QAAQ,MAAM,GAAG,GAAG,EAAE;AAAA,EAClD;AACA,SAAO;AACT;AAGO,SAAS,aAAa,QAA2B;AACtD,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,aAAO,gBAAK;AAAA,IACV,aACE;AAAA,IACF,aAAa,aAAE,OAAO;AAAA,MACpB,OAAO,aAAE,OAAO,EAAE,SAAS,mBAAmB;AAAA,MAC9C,cAAc,aAAE,OAAO,EAAE,SAAS,EAAE,SAAS,yDAAyD;AAAA,MACtG,UAAU,aAAE,OAAO,EAAE,SAAS,EAAE,SAAS,sCAAsC;AAAA,IACjF,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,OAAO,cAAc,SAAS,MAC9C,KAAK,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,cAAc,SAAS,CAAC,GAAG,GAAG;AAAA,EACtE,CAAC;AACH;AAGO,SAAS,oBAAoB,QAA2B;AAC7D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,aAAO,gBAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,aAAE,OAAO;AAAA,MACpB,OAAO,aAAE,OAAO,EAAE,SAAS,mBAAmB;AAAA,IAChD,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,MAAM,MAAM,KAAK,MAAM,EAAE,QAAQ,OAAO,EAAE,MAAM,CAAC,GAAG,GAAG;AAAA,EAC3E,CAAC;AACH;AAGO,SAAS,mBAAmB,QAA2B;AAC5D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,aAAO,gBAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,aAAE,OAAO;AAAA,MACpB,OAAO,aAAE,OAAO,EAAE,SAAS,mBAAmB;AAAA,MAC9C,MAAM,aAAE,OAAO,EAAE,SAAS,EAAE,SAAS,yBAAyB;AAAA,IAChE,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,OAAO,KAAK,MAAM,KAAK,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,KAAK,CAAC,GAAG,GAAG;AAAA,EACtF,CAAC;AACH;AAGO,SAAS,mBAAmB,QAA2B;AAC5D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,aAAO,gBAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,aAAE,OAAO;AAAA,MACpB,OAAO,aAAE,OAAO,EAAE,SAAS,2BAA2B;AAAA,MACtD,QAAQ,aAAE,OAAO,EAAE,SAAS,EAAE,SAAS,mCAAmC;AAAA,IAC5E,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,OAAO,OAAO,MAAM,KAAK,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,OAAO,CAAC,GAAG,GAAG;AAAA,EAC1F,CAAC;AACH;AAGO,SAAS,oBAAoB,QAA2B;AAC7D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,aAAO,gBAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,aAAE,OAAO;AAAA,MACpB,OAAO,aAAE,OAAO,EAAE,SAAS,2BAA2B;AAAA,IACxD,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,MAAM,MAAM,KAAK,MAAM,EAAE,QAAQ,OAAO,EAAE,MAAM,CAAC,GAAG,GAAG;AAAA,EAC3E,CAAC;AACH;AAGO,SAAS,mBAAmB,QAA2B;AAC5D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,aAAO,gBAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,aAAE,OAAO;AAAA,MACpB,SAAS,aAAE,OAAO,EAAE,SAAS,qBAAqB;AAAA,MAClD,WAAW,aAAE,OAAO,EAAE,SAAS,EAAE,SAAS,yBAAyB;AAAA,MACnE,cAAc,aAAE,OAAO,EAAE,SAAS,EAAE,SAAS,gCAAgC;AAAA,IAC/E,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,SAAS,WAAW,aAAa,MACjD,KAAK,MAAM,EAAE,OAAO,aAAa,EAAE,SAAS,WAAW,aAAa,CAAC,GAAG,GAAG;AAAA,EAC/E,CAAC;AACH;AAGO,SAAS,sBAAsB,QAA2B;AAC/D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,aAAO,gBAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,aAAE,OAAO;AAAA,MACpB,SAAS,aAAE,OAAO,EAAE,SAAS,qBAAqB;AAAA,IACpD,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,QAAQ,MAAM,KAAK,MAAM,EAAE,UAAU,YAAY,EAAE,QAAQ,CAAC,GAAG,GAAG;AAAA,EACtF,CAAC;AACH;AAMO,SAAS,YAAY,QAA2B;AACrD,SAAO;AAAA,IACL,eAAe,aAAa,MAAM;AAAA,IAClC,uBAAuB,oBAAoB,MAAM;AAAA,IACjD,sBAAsB,mBAAmB,MAAM;AAAA,IAC/C,sBAAsB,mBAAmB,MAAM;AAAA,IAC/C,uBAAuB,oBAAoB,MAAM;AAAA,IACjD,sBAAsB,mBAAmB,MAAM;AAAA,IAC/C,yBAAyB,sBAAsB,MAAM;AAAA,EACvD;AACF;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,76 @@
+import * as ai from 'ai';
+import { ScavioConfig } from 'scavio';
+
+interface ScavioToolConfig extends ScavioConfig {
+    /** Max number of results to keep in `results`-style lists. Defaults to 10. */
+    maxResults?: number;
+}
+/** Google web search. */
+declare function scavioSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+    country_code?: string | undefined;
+    language?: string | undefined;
+}, Record<string, unknown>>;
+/** YouTube video search. */
+declare function scavioYoutubeSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+}, Record<string, unknown>>;
+/** Reddit post/community search (costs 2 credits). */
+declare function scavioRedditSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+    sort?: string | undefined;
+}, Record<string, unknown>>;
+/** Amazon product search. */
+declare function scavioAmazonSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+    domain?: string | undefined;
+}, Record<string, unknown>>;
+/** Walmart product search. */
+declare function scavioWalmartSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+}, Record<string, unknown>>;
+/** TikTok video search. */
+declare function scavioTiktokSearch(config?: ScavioToolConfig): ai.Tool<{
+    keyword: string;
+    sort_type?: string | undefined;
+    publish_time?: string | undefined;
+}, Record<string, unknown>>;
+/** Instagram user search. */
+declare function scavioInstagramSearch(config?: ScavioToolConfig): ai.Tool<{
+    keyword: string;
+}, Record<string, unknown>>;
+/**
+ * All Scavio tools as an object keyed by tool name, ready to spread into the
+ * `tools` option of `generateText` / `streamText`.
+ */
+declare function scavioTools(config?: ScavioToolConfig): {
+    scavio_search: ai.Tool<{
+        query: string;
+        country_code?: string | undefined;
+        language?: string | undefined;
+    }, Record<string, unknown>>;
+    scavio_youtube_search: ai.Tool<{
+        query: string;
+    }, Record<string, unknown>>;
+    scavio_reddit_search: ai.Tool<{
+        query: string;
+        sort?: string | undefined;
+    }, Record<string, unknown>>;
+    scavio_amazon_search: ai.Tool<{
+        query: string;
+        domain?: string | undefined;
+    }, Record<string, unknown>>;
+    scavio_walmart_search: ai.Tool<{
+        query: string;
+    }, Record<string, unknown>>;
+    scavio_tiktok_search: ai.Tool<{
+        keyword: string;
+        sort_type?: string | undefined;
+        publish_time?: string | undefined;
+    }, Record<string, unknown>>;
+    scavio_instagram_search: ai.Tool<{
+        keyword: string;
+    }, Record<string, unknown>>;
+};
+
+export { type ScavioToolConfig, scavioAmazonSearch, scavioInstagramSearch, scavioRedditSearch, scavioSearch, scavioTiktokSearch, scavioTools, scavioWalmartSearch, scavioYoutubeSearch };

package/dist/index.d.ts

@@ -0,0 +1,76 @@
+import * as ai from 'ai';
+import { ScavioConfig } from 'scavio';
+
+interface ScavioToolConfig extends ScavioConfig {
+    /** Max number of results to keep in `results`-style lists. Defaults to 10. */
+    maxResults?: number;
+}
+/** Google web search. */
+declare function scavioSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+    country_code?: string | undefined;
+    language?: string | undefined;
+}, Record<string, unknown>>;
+/** YouTube video search. */
+declare function scavioYoutubeSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+}, Record<string, unknown>>;
+/** Reddit post/community search (costs 2 credits). */
+declare function scavioRedditSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+    sort?: string | undefined;
+}, Record<string, unknown>>;
+/** Amazon product search. */
+declare function scavioAmazonSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+    domain?: string | undefined;
+}, Record<string, unknown>>;
+/** Walmart product search. */
+declare function scavioWalmartSearch(config?: ScavioToolConfig): ai.Tool<{
+    query: string;
+}, Record<string, unknown>>;
+/** TikTok video search. */
+declare function scavioTiktokSearch(config?: ScavioToolConfig): ai.Tool<{
+    keyword: string;
+    sort_type?: string | undefined;
+    publish_time?: string | undefined;
+}, Record<string, unknown>>;
+/** Instagram user search. */
+declare function scavioInstagramSearch(config?: ScavioToolConfig): ai.Tool<{
+    keyword: string;
+}, Record<string, unknown>>;
+/**
+ * All Scavio tools as an object keyed by tool name, ready to spread into the
+ * `tools` option of `generateText` / `streamText`.
+ */
+declare function scavioTools(config?: ScavioToolConfig): {
+    scavio_search: ai.Tool<{
+        query: string;
+        country_code?: string | undefined;
+        language?: string | undefined;
+    }, Record<string, unknown>>;
+    scavio_youtube_search: ai.Tool<{
+        query: string;
+    }, Record<string, unknown>>;
+    scavio_reddit_search: ai.Tool<{
+        query: string;
+        sort?: string | undefined;
+    }, Record<string, unknown>>;
+    scavio_amazon_search: ai.Tool<{
+        query: string;
+        domain?: string | undefined;
+    }, Record<string, unknown>>;
+    scavio_walmart_search: ai.Tool<{
+        query: string;
+    }, Record<string, unknown>>;
+    scavio_tiktok_search: ai.Tool<{
+        keyword: string;
+        sort_type?: string | undefined;
+        publish_time?: string | undefined;
+    }, Record<string, unknown>>;
+    scavio_instagram_search: ai.Tool<{
+        keyword: string;
+    }, Record<string, unknown>>;
+};
+
+export { type ScavioToolConfig, scavioAmazonSearch, scavioInstagramSearch, scavioRedditSearch, scavioSearch, scavioTiktokSearch, scavioTools, scavioWalmartSearch, scavioYoutubeSearch };

package/dist/index.js

@@ -0,0 +1,119 @@
+// src/index.ts
+import { tool } from "ai";
+import { z } from "zod";
+import { Scavio } from "scavio";
+function client(config) {
+  return new Scavio({ apiKey: config?.apiKey });
+}
+function trim(res, max) {
+  const results = res.results;
+  if (Array.isArray(results) && results.length > max) {
+    return { ...res, results: results.slice(0, max) };
+  }
+  return res;
+}
+function scavioSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return tool({
+    description: "Search the web with Google via the Scavio API. Returns real-time organic search results.",
+    inputSchema: z.object({
+      query: z.string().describe("The search query."),
+      country_code: z.string().optional().describe('Two-letter country code to localize results, e.g. "us".'),
+      language: z.string().optional().describe('Two-letter language code, e.g. "en".')
+    }),
+    execute: async ({ query, country_code, language }) => trim(await c.google.search({ query, country_code, language }), max)
+  });
+}
+function scavioYoutubeSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return tool({
+    description: "Search YouTube for videos via the Scavio API.",
+    inputSchema: z.object({
+      query: z.string().describe("The search query.")
+    }),
+    execute: async ({ query }) => trim(await c.youtube.search({ query }), max)
+  });
+}
+function scavioRedditSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return tool({
+    description: "Search Reddit posts and communities via the Scavio API.",
+    inputSchema: z.object({
+      query: z.string().describe("The search query."),
+      sort: z.string().optional().describe("Sort order for results.")
+    }),
+    execute: async ({ query, sort }) => trim(await c.reddit.search({ query, sort }), max)
+  });
+}
+function scavioAmazonSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return tool({
+    description: "Search Amazon for products via the Scavio API.",
+    inputSchema: z.object({
+      query: z.string().describe("The product search query."),
+      domain: z.string().optional().describe('Amazon domain, e.g. "amazon.com".')
+    }),
+    execute: async ({ query, domain }) => trim(await c.amazon.search({ query, domain }), max)
+  });
+}
+function scavioWalmartSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return tool({
+    description: "Search Walmart for products via the Scavio API.",
+    inputSchema: z.object({
+      query: z.string().describe("The product search query.")
+    }),
+    execute: async ({ query }) => trim(await c.walmart.search({ query }), max)
+  });
+}
+function scavioTiktokSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return tool({
+    description: "Search TikTok for videos by keyword via the Scavio API.",
+    inputSchema: z.object({
+      keyword: z.string().describe("The search keyword."),
+      sort_type: z.string().optional().describe("Sort order for results."),
+      publish_time: z.string().optional().describe("Filter by publish time window.")
+    }),
+    execute: async ({ keyword, sort_type, publish_time }) => trim(await c.tiktok.searchVideos({ keyword, sort_type, publish_time }), max)
+  });
+}
+function scavioInstagramSearch(config) {
+  const c = client(config);
+  const max = config?.maxResults ?? 10;
+  return tool({
+    description: "Search Instagram for users by keyword via the Scavio API.",
+    inputSchema: z.object({
+      keyword: z.string().describe("The search keyword.")
+    }),
+    execute: async ({ keyword }) => trim(await c.instagram.searchUsers({ keyword }), max)
+  });
+}
+function scavioTools(config) {
+  return {
+    scavio_search: scavioSearch(config),
+    scavio_youtube_search: scavioYoutubeSearch(config),
+    scavio_reddit_search: scavioRedditSearch(config),
+    scavio_amazon_search: scavioAmazonSearch(config),
+    scavio_walmart_search: scavioWalmartSearch(config),
+    scavio_tiktok_search: scavioTiktokSearch(config),
+    scavio_instagram_search: scavioInstagramSearch(config)
+  };
+}
+export {
+  scavioAmazonSearch,
+  scavioInstagramSearch,
+  scavioRedditSearch,
+  scavioSearch,
+  scavioTiktokSearch,
+  scavioTools,
+  scavioWalmartSearch,
+  scavioYoutubeSearch
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { tool } from \"ai\";\nimport { z } from \"zod\";\nimport { Scavio, type ScavioConfig } from \"scavio\";\n\nexport interface ScavioToolConfig extends ScavioConfig {\n  /** Max number of results to keep in `results`-style lists. Defaults to 10. */\n  maxResults?: number;\n}\n\nfunction client(config?: ScavioToolConfig): Scavio {\n  return new Scavio({ apiKey: config?.apiKey });\n}\n\nfunction trim(res: Record<string, unknown>, max: number): Record<string, unknown> {\n  const results = res.results;\n  if (Array.isArray(results) && results.length > max) {\n    return { ...res, results: results.slice(0, max) };\n  }\n  return res;\n}\n\n/** Google web search. */\nexport function scavioSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description:\n      \"Search the web with Google via the Scavio API. Returns real-time organic search results.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The search query.\"),\n      country_code: z.string().optional().describe('Two-letter country code to localize results, e.g. \"us\".'),\n      language: z.string().optional().describe('Two-letter language code, e.g. \"en\".'),\n    }),\n    execute: async ({ query, country_code, language }) =>\n      trim(await c.google.search({ query, country_code, language }), max),\n  });\n}\n\n/** YouTube video search. */\nexport function scavioYoutubeSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search YouTube for videos via the Scavio API.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The search query.\"),\n    }),\n    execute: async ({ query }) => trim(await c.youtube.search({ query }), max),\n  });\n}\n\n/** Reddit post/community search (costs 2 credits). */\nexport function scavioRedditSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search Reddit posts and communities via the Scavio API.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The search query.\"),\n      sort: z.string().optional().describe(\"Sort order for results.\"),\n    }),\n    execute: async ({ query, sort }) => trim(await c.reddit.search({ query, sort }), max),\n  });\n}\n\n/** Amazon product search. */\nexport function scavioAmazonSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search Amazon for products via the Scavio API.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The product search query.\"),\n      domain: z.string().optional().describe('Amazon domain, e.g. \"amazon.com\".'),\n    }),\n    execute: async ({ query, domain }) => trim(await c.amazon.search({ query, domain }), max),\n  });\n}\n\n/** Walmart product search. */\nexport function scavioWalmartSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search Walmart for products via the Scavio API.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The product search query.\"),\n    }),\n    execute: async ({ query }) => trim(await c.walmart.search({ query }), max),\n  });\n}\n\n/** TikTok video search. */\nexport function scavioTiktokSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search TikTok for videos by keyword via the Scavio API.\",\n    inputSchema: z.object({\n      keyword: z.string().describe(\"The search keyword.\"),\n      sort_type: z.string().optional().describe(\"Sort order for results.\"),\n      publish_time: z.string().optional().describe(\"Filter by publish time window.\"),\n    }),\n    execute: async ({ keyword, sort_type, publish_time }) =>\n      trim(await c.tiktok.searchVideos({ keyword, sort_type, publish_time }), max),\n  });\n}\n\n/** Instagram user search. */\nexport function scavioInstagramSearch(config?: ScavioToolConfig) {\n  const c = client(config);\n  const max = config?.maxResults ?? 10;\n  return tool({\n    description: \"Search Instagram for users by keyword via the Scavio API.\",\n    inputSchema: z.object({\n      keyword: z.string().describe(\"The search keyword.\"),\n    }),\n    execute: async ({ keyword }) => trim(await c.instagram.searchUsers({ keyword }), max),\n  });\n}\n\n/**\n * All Scavio tools as an object keyed by tool name, ready to spread into the\n * `tools` option of `generateText` / `streamText`.\n */\nexport function scavioTools(config?: ScavioToolConfig) {\n  return {\n    scavio_search: scavioSearch(config),\n    scavio_youtube_search: scavioYoutubeSearch(config),\n    scavio_reddit_search: scavioRedditSearch(config),\n    scavio_amazon_search: scavioAmazonSearch(config),\n    scavio_walmart_search: scavioWalmartSearch(config),\n    scavio_tiktok_search: scavioTiktokSearch(config),\n    scavio_instagram_search: scavioInstagramSearch(config),\n  };\n}\n"],"mappings":";AAAA,SAAS,YAAY;AACrB,SAAS,SAAS;AAClB,SAAS,cAAiC;AAO1C,SAAS,OAAO,QAAmC;AACjD,SAAO,IAAI,OAAO,EAAE,QAAQ,QAAQ,OAAO,CAAC;AAC9C;AAEA,SAAS,KAAK,KAA8B,KAAsC;AAChF,QAAM,UAAU,IAAI;AACpB,MAAI,MAAM,QAAQ,OAAO,KAAK,QAAQ,SAAS,KAAK;AAClD,WAAO,EAAE,GAAG,KAAK,SAAS,QAAQ,MAAM,GAAG,GAAG,EAAE;AAAA,EAClD;AACA,SAAO;AACT;AAGO,SAAS,aAAa,QAA2B;AACtD,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,SAAO,KAAK;AAAA,IACV,aACE;AAAA,IACF,aAAa,EAAE,OAAO;AAAA,MACpB,OAAO,EAAE,OAAO,EAAE,SAAS,mBAAmB;AAAA,MAC9C,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,yDAAyD;AAAA,MACtG,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,sCAAsC;AAAA,IACjF,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,OAAO,cAAc,SAAS,MAC9C,KAAK,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,cAAc,SAAS,CAAC,GAAG,GAAG;AAAA,EACtE,CAAC;AACH;AAGO,SAAS,oBAAoB,QAA2B;AAC7D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,SAAO,KAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,EAAE,OAAO;AAAA,MACpB,OAAO,EAAE,OAAO,EAAE,SAAS,mBAAmB;AAAA,IAChD,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,MAAM,MAAM,KAAK,MAAM,EAAE,QAAQ,OAAO,EAAE,MAAM,CAAC,GAAG,GAAG;AAAA,EAC3E,CAAC;AACH;AAGO,SAAS,mBAAmB,QAA2B;AAC5D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,SAAO,KAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,EAAE,OAAO;AAAA,MACpB,OAAO,EAAE,OAAO,EAAE,SAAS,mBAAmB;AAAA,MAC9C,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,yBAAyB;AAAA,IAChE,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,OAAO,KAAK,MAAM,KAAK,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,KAAK,CAAC,GAAG,GAAG;AAAA,EACtF,CAAC;AACH;AAGO,SAAS,mBAAmB,QAA2B;AAC5D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,SAAO,KAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,EAAE,OAAO;AAAA,MACpB,OAAO,EAAE,OAAO,EAAE,SAAS,2BAA2B;AAAA,MACtD,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,mCAAmC;AAAA,IAC5E,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,OAAO,OAAO,MAAM,KAAK,MAAM,EAAE,OAAO,OAAO,EAAE,OAAO,OAAO,CAAC,GAAG,GAAG;AAAA,EAC1F,CAAC;AACH;AAGO,SAAS,oBAAoB,QAA2B;AAC7D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,SAAO,KAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,EAAE,OAAO;AAAA,MACpB,OAAO,EAAE,OAAO,EAAE,SAAS,2BAA2B;AAAA,IACxD,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,MAAM,MAAM,KAAK,MAAM,EAAE,QAAQ,OAAO,EAAE,MAAM,CAAC,GAAG,GAAG;AAAA,EAC3E,CAAC;AACH;AAGO,SAAS,mBAAmB,QAA2B;AAC5D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,SAAO,KAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,EAAE,OAAO;AAAA,MACpB,SAAS,EAAE,OAAO,EAAE,SAAS,qBAAqB;AAAA,MAClD,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,yBAAyB;AAAA,MACnE,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,gCAAgC;AAAA,IAC/E,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,SAAS,WAAW,aAAa,MACjD,KAAK,MAAM,EAAE,OAAO,aAAa,EAAE,SAAS,WAAW,aAAa,CAAC,GAAG,GAAG;AAAA,EAC/E,CAAC;AACH;AAGO,SAAS,sBAAsB,QAA2B;AAC/D,QAAM,IAAI,OAAO,MAAM;AACvB,QAAM,MAAM,QAAQ,cAAc;AAClC,SAAO,KAAK;AAAA,IACV,aAAa;AAAA,IACb,aAAa,EAAE,OAAO;AAAA,MACpB,SAAS,EAAE,OAAO,EAAE,SAAS,qBAAqB;AAAA,IACpD,CAAC;AAAA,IACD,SAAS,OAAO,EAAE,QAAQ,MAAM,KAAK,MAAM,EAAE,UAAU,YAAY,EAAE,QAAQ,CAAC,GAAG,GAAG;AAAA,EACtF,CAAC;AACH;AAMO,SAAS,YAAY,QAA2B;AACrD,SAAO;AAAA,IACL,eAAe,aAAa,MAAM;AAAA,IAClC,uBAAuB,oBAAoB,MAAM;AAAA,IACjD,sBAAsB,mBAAmB,MAAM;AAAA,IAC/C,sBAAsB,mBAAmB,MAAM;AAAA,IAC/C,uBAAuB,oBAAoB,MAAM;AAAA,IACjD,sBAAsB,mBAAmB,MAAM;AAAA,IAC/C,yBAAyB,sBAAsB,MAAM;AAAA,EACvD;AACF;","names":[]}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@scavio/ai-sdk",
+  "version": "0.2.0",
+  "description": "Scavio search tools for the Vercel AI SDK (Google, YouTube, Reddit, Amazon, Walmart, TikTok, Instagram).",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "scavio",
+    "ai",
+    "vercel-ai-sdk",
+    "tools",
+    "search",
+    "agents"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/scavio-ai/scavio-ai.git"
+  },
+  "homepage": "https://scavio.dev",
+  "peerDependencies": {
+    "ai": ">=4",
+    "zod": ">=3"
+  },
+  "dependencies": {
+    "scavio": "^0.2.1"
+  },
+  "devDependencies": {
+    "@ai-sdk/openai": "^3.0.74",
+    "ai": "^6.0.208",
+    "scavio": "^0.2.1",
+    "tsup": "^8.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^2.0.0",
+    "zod": "^3.23.0"
+  }
+}