@ever-works/valyu-plugin 1.0.0 → 1.0.3

package/dist/index.js

@@ -0,0 +1,351 @@
+import { Valyu } from 'valyu-js';
+import { isIP } from 'net';
+
+// src/valyu.plugin.ts
+function isSafeWebhookUrl(rawUrl) {
+  let url;
+  try {
+    url = new URL(rawUrl);
+  } catch {
+    return false;
+  }
+  if (url.protocol !== "https:" && url.protocol !== "http:") {
+    return false;
+  }
+  let host = url.hostname.toLowerCase();
+  if (host.startsWith("[") && host.endsWith("]")) {
+    host = host.slice(1, -1);
+  }
+  if (CLOUD_METADATA_HOSTNAMES.has(host)) {
+    return false;
+  }
+  const ipKind = isIP(host);
+  if (ipKind === 4 && isPrivateIPv4(host)) return false;
+  if (ipKind === 6 && isPrivateIPv6(host)) return false;
+  return true;
+}
+var CLOUD_METADATA_HOSTNAMES = /* @__PURE__ */ new Set([
+  // GCP
+  "metadata.google.internal",
+  "metadata.goog",
+  // AWS
+  "instance-data",
+  "instance-data.ec2.internal",
+  // Azure
+  "metadata.azure.internal"
+]);
+function isPrivateIPv4(ip) {
+  const parts = ip.split(".").map((p) => Number(p));
+  if (parts.length !== 4 || parts.some((n) => Number.isNaN(n))) return false;
+  const [a, b] = parts;
+  if (a === 10) return true;
+  if (a === 127) return true;
+  if (a === 0) return true;
+  if (a === 169 && b === 254) return true;
+  if (a === 172 && b >= 16 && b <= 31) return true;
+  if (a === 192 && b === 168) return true;
+  if (a === 192 && b === 0 && parts[2] === 0) return true;
+  if (a === 100 && b >= 64 && b <= 127) return true;
+  if (a >= 224) return true;
+  return false;
+}
+function isPrivateIPv6(ip) {
+  const lower = ip.toLowerCase();
+  if (lower === "::1" || lower === "::") return true;
+  if (lower.startsWith("fc") || lower.startsWith("fd")) return true;
+  const firstHextet = lower.split(":", 1)[0];
+  if (/^[0-9a-f]{1,4}$/.test(firstHextet)) {
+    const group0 = parseInt(firstHextet, 16);
+    if ((group0 & 65472) === 65152) return true;
+  }
+  if (lower.startsWith("::ffff:")) {
+    const v4 = lower.slice("::ffff:".length);
+    if (isIP(v4) === 4) return isPrivateIPv4(v4);
+  }
+  return false;
+}
+
+// src/valyu.plugin.ts
+var ValyuSearchPlugin = class {
+  id = "valyu";
+  name = "Valyu";
+  version = "1.0.0";
+  category = "search";
+  capabilities = ["search", "content-extractor"];
+  providerName = "Valyu";
+  settingsSchema = {
+    type: "object",
+    properties: {
+      apiKey: {
+        type: "string",
+        title: "API Key",
+        description: "Your Valyu API key. Get one at https://valyu.ai",
+        "x-secret": true,
+        "x-envVar": "PLUGIN_VALYU_API_KEY",
+        "x-scope": "user"
+      },
+      responseLength: {
+        type: "string",
+        title: "Response Length",
+        description: "Content volume per result: short (~25k chars), medium (~50k), large (~100k), or max (unlimited)",
+        enum: ["short", "medium", "large", "max"],
+        default: "medium"
+      }
+    },
+    required: ["apiKey"]
+  };
+  configurationMode = "hybrid";
+  context;
+  async search(options) {
+    const client = this.getClient(options.settings);
+    const startTime = Date.now();
+    const maxNumResults = options.limit || 20;
+    const responseLength = options.settings?.responseLength || "medium";
+    try {
+      const searchOptions = {
+        searchType: "all",
+        maxNumResults,
+        responseLength
+      };
+      if (options.includeDomains && options.includeDomains.length > 0) {
+        searchOptions.includedSources = options.includeDomains;
+      } else if (options.excludeDomains && options.excludeDomains.length > 0) {
+        searchOptions.excludeSources = options.excludeDomains;
+      }
+      if (options.region) {
+        searchOptions.countryCode = options.region.toUpperCase();
+      }
+      if (options.timeRange && options.timeRange !== "all") {
+        const now = /* @__PURE__ */ new Date();
+        const start = new Date(now);
+        if (options.timeRange === "day") start.setDate(now.getDate() - 1);
+        else if (options.timeRange === "week") start.setDate(now.getDate() - 7);
+        else if (options.timeRange === "month") start.setMonth(now.getMonth() - 1);
+        else if (options.timeRange === "year") start.setFullYear(now.getFullYear() - 1);
+        searchOptions.startDate = start.toISOString().split("T")[0];
+        searchOptions.endDate = now.toISOString().split("T")[0];
+      }
+      const response = await client.search(options.query, searchOptions);
+      const results = (response.results || []).map((r, index) => ({
+        title: r.title,
+        url: r.url,
+        snippet: typeof r.content === "string" ? r.content : String(r.content),
+        position: index + 1,
+        publishedDate: r.publication_date,
+        metadata: {
+          relevanceScore: r.relevance_score,
+          source: r.source,
+          description: r.description
+        }
+      }));
+      return {
+        results,
+        query: options.query,
+        totalResults: results.length,
+        hasMore: false,
+        duration: Date.now() - startTime
+      };
+    } catch (error) {
+      this.context?.logger.error(
+        `Valyu search failed: ${error instanceof Error ? error.message : String(error)}`
+      );
+      throw error;
+    }
+  }
+  async isAvailable() {
+    if (!this.context) return false;
+    const settings = await this.context.getSettings();
+    return Boolean(settings?.apiKey);
+  }
+  async validateConnection(settings) {
+    const apiKey = settings.apiKey;
+    if (!apiKey) {
+      return { success: false, message: "Valyu API key is not configured." };
+    }
+    try {
+      const client = this.getClient(settings);
+      await client.search("test", { maxNumResults: 1, searchType: "all" });
+      return { success: true, message: "Valyu connection verified." };
+    } catch (error) {
+      return {
+        success: false,
+        message: `Valyu connection failed: ${error instanceof Error ? error.message : String(error)}`
+      };
+    }
+  }
+  async getRateLimitInfo() {
+    return {
+      remaining: -1,
+      limit: -1,
+      period: "month"
+    };
+  }
+  async extract(options) {
+    const client = this.getClient(options.settings);
+    const startTime = Date.now();
+    if (!isSafeWebhookUrl(options.url)) {
+      return {
+        success: false,
+        url: options.url,
+        error: `URL host is not safe to fetch (SSRF guard blocked: ${options.url})`,
+        duration: Date.now() - startTime
+      };
+    }
+    try {
+      const response = await client.contents([options.url]);
+      if (!response.results || response.results.length === 0) {
+        return {
+          success: false,
+          url: options.url,
+          error: "No content extracted",
+          duration: Date.now() - startTime
+        };
+      }
+      const result = response.results[0];
+      const content = typeof result.content === "string" ? result.content : String(result.content || "");
+      return {
+        success: true,
+        url: options.url,
+        finalUrl: result.url !== options.url ? result.url : void 0,
+        title: result.title,
+        content,
+        markdown: content,
+        duration: Date.now() - startTime,
+        wordCount: content ? content.split(/\s+/).length : 0
+      };
+    } catch (error) {
+      return {
+        success: false,
+        url: options.url,
+        error: error instanceof Error ? error.message : String(error),
+        duration: Date.now() - startTime
+      };
+    }
+  }
+  async extractBatch(urls, options) {
+    const client = this.getClient(options?.settings);
+    const startTime = Date.now();
+    const safeUrls = [];
+    const blockedResults = [];
+    for (const url of urls) {
+      if (isSafeWebhookUrl(url)) {
+        safeUrls.push(url);
+      } else {
+        blockedResults.push({
+          success: false,
+          url,
+          error: `URL host is not safe to fetch (SSRF guard blocked: ${url})`,
+          duration: Date.now() - startTime
+        });
+      }
+    }
+    try {
+      const batchSize = 10;
+      const allResults = [];
+      for (let i = 0; i < safeUrls.length; i += batchSize) {
+        const batch = safeUrls.slice(i, i + batchSize);
+        const response = await client.contents(batch);
+        const results = (response.results || []).map((result, index) => {
+          const content = typeof result.content === "string" ? result.content : String(result.content || "");
+          const requestedUrl = batch[index] || result.url;
+          return {
+            success: true,
+            url: requestedUrl,
+            finalUrl: result.url !== requestedUrl ? result.url : void 0,
+            title: result.title,
+            content,
+            markdown: content,
+            duration: Date.now() - startTime,
+            wordCount: content ? content.split(/\s+/).length : 0
+          };
+        });
+        allResults.push(...results);
+      }
+      return [...blockedResults, ...allResults];
+    } catch (error) {
+      const failed = safeUrls.map((url) => ({
+        success: false,
+        url,
+        error: error instanceof Error ? error.message : String(error),
+        duration: Date.now() - startTime
+      }));
+      return [...blockedResults, ...failed];
+    }
+  }
+  async canExtract(url) {
+    return isSafeWebhookUrl(url);
+  }
+  getSupportedFormats() {
+    return ["text", "markdown"];
+  }
+  getClient(settings) {
+    const apiKey = settings?.apiKey;
+    if (!apiKey) {
+      throw new Error(
+        "Valyu API key not configured. Set it in plugin settings or via PLUGIN_VALYU_API_KEY environment variable."
+      );
+    }
+    return new Valyu(apiKey);
+  }
+  async onLoad(context) {
+    this.context = context;
+    context.logger.log("Valyu Plugin loaded");
+  }
+  async onUnload() {
+    this.context = void 0;
+  }
+  async healthCheck() {
+    return {
+      status: "healthy",
+      message: "Valyu plugin is ready (API key required for operations)",
+      checkedAt: Date.now()
+    };
+  }
+  getManifest() {
+    return {
+      id: this.id,
+      name: this.name,
+      version: this.version,
+      description: "AI-native search and content extraction across web and proprietary data sources",
+      category: this.category,
+      capabilities: [...this.capabilities],
+      author: { name: "Ever Works Team" },
+      license: "AGPL-3.0",
+      builtIn: true,
+      systemPlugin: false,
+      autoEnable: false,
+      homepage: "https://valyu.ai",
+      icon: {
+        type: "svg",
+        value: `<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100" viewBox="0 0 100 100" preserveAspectRatio="xMidYMid meet"><g fill="#1e1d1d" fill-opacity="1"><g transform="translate(-3, 88)"><path d="M 48.3125 1.734375 L 59.78125 1.734375 L 91.5625 -71.453125 L 91.5625 -77.5 L 16.328125 -77.5 L 16.328125 -71.453125 Z M 64.421875 -32.640625 L 54.15625 -7.140625 L 53.609375 -7.140625 L 43.234375 -32.640625 L 27.78125 -68.96875 L 79.984375 -68.96875 Z M 64.421875 -32.640625 "/></g></g></svg>`,
+        darkValue: `<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100" viewBox="0 0 100 100" preserveAspectRatio="xMidYMid meet"><g fill="#ebebeb" fill-opacity="1"><g transform="translate(-3, 88)"><path d="M 48.3125 1.734375 L 59.78125 1.734375 L 91.5625 -71.453125 L 91.5625 -77.5 L 16.328125 -77.5 L 16.328125 -71.453125 Z M 64.421875 -32.640625 L 54.15625 -7.140625 L 53.609375 -7.140625 L 43.234375 -32.640625 L 27.78125 -68.96875 L 79.984375 -68.96875 Z M 64.421875 -32.640625 "/></g></g></svg>`
+      },
+      readme: [
+        "## What does Valyu do?",
+        "",
+        "Valyu is an AI-native search and content extraction service that searches across web and proprietary data sources. It returns results optimized for AI applications and RAG pipelines, providing the source material that Ever Works uses to generate accurate work items.",
+        "",
+        "## Why use it?",
+        "",
+        "- **Multi-source search** \u2014 search across web, proprietary datasets (arXiv, PubMed, financial data), and news",
+        "- **AI-optimized results** \u2014 returns content formatted for AI processing with relevance scoring",
+        "- **Content extraction** \u2014 pulls clean text and markdown from web pages",
+        "- **Domain filtering** \u2014 include or exclude specific websites from search results",
+        "- **Date filtering** \u2014 restrict results to specific time periods",
+        "",
+        "## How it works in Ever Works",
+        "",
+        "During work generation, the search facade uses Valyu to find information about each item, discover relevant source URLs, and extract content from web pages. This powers automatic descriptions, source URL resolution, and content enrichment across the generation pipeline.",
+        "",
+        "## Getting started",
+        "",
+        "1. Create an account at [valyu.ai](https://valyu.ai)",
+        "2. Copy your API key from the Valyu dashboard",
+        "3. Enter the key in the **API Key** field below",
+        "4. Valyu will be used during work generation when selected as the search provider"
+      ].join("\n")
+    };
+  }
+};
+
+export { ValyuSearchPlugin, ValyuSearchPlugin as default };

package/package.json

@@ -1,78 +1,91 @@
 {
-  "name": "@ever-works/valyu-plugin",
-  "version": "1.0.0",
-  "description": "Valyu Plugin - Web search and content extraction using Valyu API",
-  "author": {
-    "name": "Ever Co. LTD",
-    "email": "ever@ever.co",
-    "url": "https://ever.co"
-  },
-  "license": "AGPL-3.0",
-  "private": false,
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    }
-  },
-  "dependencies": {
-    "valyu-js": "^2.5.4"
-  },
-  "peerDependencies": {
-    "@ever-works/plugin": "1.1.0"
-  },
-  "devDependencies": {
-    "@types/node": "^22.0.0",
-    "tsup": "^8.4.0",
-    "typescript": "^5.7.3",
-    "vitest": "^4.1.0",
-    "@ever-works/plugin": "1.1.0"
-  },
-  "everworks": {
-    "plugin": {
-      "id": "valyu",
-      "name": "Valyu",
-      "version": "1.0.0",
-      "category": "search",
-      "capabilities": [
-        "search",
-        "content-extractor"
-      ],
-      "description": "AI-native search and content extraction using the Valyu API. Supports web, proprietary, and news search with optional content extraction from URLs.",
-      "author": {
-        "name": "Ever Works Team"
-      },
-      "license": "AGPL-3.0",
-      "autoEnable": false,
-      "systemPlugin": false,
-      "builtIn": true,
-      "envVars": [
-        {
-          "name": "PLUGIN_VALYU_API_KEY",
-          "required": false,
-          "secret": true,
-          "description": "Valyu API key (optional - can be set via admin/user settings)"
-        }
-      ],
-      "distribution": "registry"
-    }
-  },
-  "publishConfig": {
-    "access": "restricted",
-    "registry": "https://registry.npmjs.org"
-  },
-  "scripts": {
-    "build": "tsc --noEmit && tsup",
-    "dev": "tsup --watch",
-    "type-check": "tsc --noEmit",
-    "clean": "rm -rf dist",
-    "test": "vitest run --passWithNoTests",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage"
-  }
-}
+	"name": "@ever-works/valyu-plugin",
+	"version": "1.0.3",
+	"description": "Valyu Plugin - Web search and content extraction using Valyu API",
+	"author": {
+		"name": "Ever Co. LTD",
+		"email": "ever@ever.co",
+		"url": "https://ever.co"
+	},
+	"license": "AGPL-3.0",
+	"private": false,
+	"type": "module",
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc --noEmit && tsup",
+		"dev": "tsup --watch",
+		"type-check": "tsc --noEmit",
+		"clean": "rm -rf dist",
+		"test": "vitest run --passWithNoTests",
+		"test:watch": "vitest",
+		"test:coverage": "vitest run --coverage"
+	},
+	"dependencies": {
+		"valyu-js": "^2.5.4"
+	},
+	"peerDependencies": {
+		"@ever-works/plugin": "^1.2.5"
+	},
+	"devDependencies": {
+		"@types/node": "^26.6.4",
+		"@ever-works/plugin": "^1.2.5",
+		"tsup": "^8.4.0",
+		"typescript": "^5.7.3",
+		"vitest": "^5.0.5"
+	},
+	"everworks": {
+		"plugin": {
+			"id": "valyu",
+			"name": "Valyu",
+			"version": "1.0.0",
+			"category": "search",
+			"capabilities": [
+				"search",
+				"content-extractor"
+			],
+			"description": "AI-native search and content extraction using the Valyu API. Supports web, proprietary, and news search with optional content extraction from URLs.",
+			"author": {
+				"name": "Ever Works Team"
+			},
+			"license": "AGPL-3.0",
+			"autoEnable": false,
+			"systemPlugin": false,
+			"builtIn": true,
+			"envVars": [
+				{
+					"name": "PLUGIN_VALYU_API_KEY",
+					"required": false,
+					"secret": true,
+					"description": "Valyu API key (optional - can be set via admin/user settings)"
+				}
+			],
+			"distribution": "registry"
+		}
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/ever-works/ever-works.git",
+		"directory": "packages/plugins/valyu"
+	},
+	"homepage": "https://github.com/ever-works/ever-works/tree/main/packages/plugins/valyu#readme",
+	"bugs": {
+		"url": "https://github.com/ever-works/ever-works/issues"
+	},
+	"everworksRelease": {
+		"contentHash": "sha256:8c8dea8cf388efe55f03d52a1113baed5d57e56ec7d9a0ddb65c7ab2eda23022",
+		"commit": "19905c70cf05be3bc523db030597046067cd322a",
+		"source": "https://github.com/ever-works/ever-works/tree/19905c70cf05be3bc523db030597046067cd322a/packages/plugins/valyu"
+	}
+}