@avalw/search-worker 1.1.0 → 2.1.0

package/package.json

@@ -1,41 +1,34 @@
 {
   "name": "@avalw/search-worker",
-  "version": "1.1.0",
-  "description": "AVALW Search Worker - Contribute compute power, get free privacy-focused search API access",
-  "main": "lib/worker.js",
+  "version": "2.1.0",
+  "description": "AVALW Distributed Cache Worker - Intelligent caching with size limits and auto-cleanup",
+  "main": "index.js",
   "bin": {
     "avalw-worker": "./bin/cli.js"
   },
   "scripts": {
     "start": "node bin/cli.js",
-    "test": "node test/test.js"
+    "test": "echo \"Tests coming soon\" && exit 0"
   },
   "keywords": [
     "avalw",
     "search",
     "worker",
     "distributed",
-    "api",
-    "privacy",
-    "search-engine",
-    "decentralized"
+    "cache",
+    "compute"
   ],
-  "author": "AVALW <contact@avalw.com>",
+  "author": "AVALW Team",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/avalw/search-worker"
+  },
   "homepage": "https://worker.avalw.org",
+  "dependencies": {
+    "ws": "^8.14.2"
+  },
   "engines": {
     "node": ">=14.0.0"
-  },
-  "os": [
-    "darwin",
-    "linux",
-    "win32"
-  ],
-  "files": [
-    "bin/",
-    "lib/",
-    "examples/",
-    "README.md",
-    "LICENSE"
-  ]
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 AVALW
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/examples/basic-usage.js

@@ -1,32 +0,0 @@
-/**
- * Basic Usage Example
- *
- * This example shows how to use the AVALW Worker programmatically
- * in your Node.js application.
- */
-
-const { AvalwWorker } = require('@avalw/search-worker');
-
-// Replace with your actual token from worker.avalw.org
-const WORKER_TOKEN = 'YOUR_WORKER_TOKEN_HERE';
-
-async function main() {
-  // Create worker instance
-  const worker = new AvalwWorker(WORKER_TOKEN);
-
-  // Handle shutdown gracefully
-  process.on('SIGINT', async () => {
-    console.log('\nStopping worker...');
-    await worker.stop();
-    process.exit(0);
-  });
-
-  // Start the worker
-  console.log('Starting AVALW Worker...');
-  await worker.start();
-
-  // Worker is now running and contributing compute power
-  // Your search API is now active!
-}
-
-main().catch(console.error);

package/examples/express-integration.js

@@ -1,73 +0,0 @@
-/**
- * Express.js Integration Example
- *
- * This example shows how to integrate AVALW Search
- * into an Express.js application.
- */
-
-const express = require('express');
-const { AvalwWorker } = require('@avalw/search-worker');
-
-// Replace with your actual token
-const WORKER_TOKEN = 'YOUR_WORKER_TOKEN_HERE';
-const API_URL = 'https://worker.avalw.org';
-
-const app = express();
-const PORT = 3000;
-
-// Start the worker when the server starts
-const worker = new AvalwWorker(WORKER_TOKEN);
-
-// Search endpoint for your users
-app.get('/search', async (req, res) => {
-  const { q, page = 1 } = req.query;
-
-  if (!q) {
-    return res.status(400).json({ error: 'Query parameter "q" is required' });
-  }
-
-  try {
-    const params = new URLSearchParams({
-      q,
-      token: WORKER_TOKEN,
-      page: page.toString()
-    });
-
-    const response = await fetch(`${API_URL}/api/search?${params}`);
-    const results = await response.json();
-
-    res.json(results);
-  } catch (error) {
-    res.status(500).json({ error: 'Search failed', message: error.message });
-  }
-});
-
-// Health check
-app.get('/health', (req, res) => {
-  res.json({
-    status: 'ok',
-    worker: worker.running ? 'running' : 'stopped'
-  });
-});
-
-// Start server and worker
-async function start() {
-  // Start the AVALW worker
-  await worker.start();
-  console.log('AVALW Worker started');
-
-  // Start Express server
-  app.listen(PORT, () => {
-    console.log(`Server running on http://localhost:${PORT}`);
-    console.log(`Try: http://localhost:${PORT}/search?q=test`);
-  });
-}
-
-// Graceful shutdown
-process.on('SIGINT', async () => {
-  console.log('\nShutting down...');
-  await worker.stop();
-  process.exit(0);
-});
-
-start().catch(console.error);

package/examples/search-api.js

@@ -1,58 +0,0 @@
-/**
- * Search API Example
- *
- * This example shows how to use the AVALW Search API
- * once your worker is running.
- */
-
-// Replace with your actual token
-const WORKER_TOKEN = 'YOUR_WORKER_TOKEN_HERE';
-const API_URL = 'https://worker.avalw.org';
-
-/**
- * Search using the AVALW API
- * @param {string} query - Search query
- * @param {number} page - Page number (optional)
- * @returns {Promise<object>} Search results
- */
-async function search(query, page = 1) {
-  const params = new URLSearchParams({
-    q: query,
-    token: WORKER_TOKEN,
-    page: page.toString()
-  });
-
-  const response = await fetch(`${API_URL}/api/search?${params}`);
-
-  if (!response.ok) {
-    throw new Error(`Search failed: ${response.statusText}`);
-  }
-
-  return response.json();
-}
-
-// Example usage
-async function main() {
-  try {
-    console.log('Searching for "privacy search engine"...\n');
-
-    const results = await search('privacy search engine');
-
-    if (results.success) {
-      console.log(`Found ${results.total || results.results?.length || 0} results:\n`);
-
-      results.results?.forEach((result, index) => {
-        console.log(`${index + 1}. ${result.title}`);
-        console.log(`   ${result.url}`);
-        console.log(`   ${result.snippet?.substring(0, 100)}...`);
-        console.log('');
-      });
-    } else {
-      console.log('Search error:', results.error);
-    }
-  } catch (error) {
-    console.error('Error:', error.message);
-  }
-}
-
-main();

package/lib/worker.js

@@ -1,319 +0,0 @@
-/**
- * AVALW Search Worker v1.1.0
- * Connects to worker.avalw.org and contributes compute power
- * in exchange for free search API access.
- *
- * Uses Core-Hours calculation for fair tier distribution.
- */
-
-const https = require('https');
-const http = require('http');
-const os = require('os');
-
-// Tier definitions based on core-hours
-const TIERS = {
-  STARTER:    { name: 'Starter',    coreHours: 3,   requests: 1000,   minCores: 3 },
-  BASIC:      { name: 'Basic',      coreHours: 12,  requests: 5000,   minCores: 4 },
-  PRO:        { name: 'Pro',        coreHours: 36,  requests: 20000,  minCores: 6 },
-  BUSINESS:   { name: 'Business',   coreHours: 72,  requests: 50000,  minCores: 8 },
-  ENTERPRISE: { name: 'Enterprise', coreHours: 240, requests: 500000, minCores: 16 }
-};
-
-class AvalwWorker {
-  constructor(token, apiUrl = 'https://worker.avalw.org') {
-    this.token = token;
-    this.apiUrl = apiUrl;
-    this.running = false;
-    this.heartbeatInterval = null;
-    this.startTime = null;
-    this.coreHoursToday = 0;
-    this.currentTier = null;
-    this.cpuInfo = this.getCpuInfo();
-  }
-
-  /**
-   * Get detailed CPU information
-   */
-  getCpuInfo() {
-    const cpus = os.cpus();
-    const cores = cpus.length;
-    const model = cpus[0]?.model || 'Unknown';
-
-    // Extract speed from CPU model or use reported speed
-    let speedGHz = cpus[0]?.speed ? cpus[0].speed / 1000 : 2.5;
-
-    // Try to parse speed from model string (e.g., "@ 2.90GHz")
-    const speedMatch = model.match(/@\s*([\d.]+)\s*GHz/i);
-    if (speedMatch) {
-      speedGHz = parseFloat(speedMatch[1]);
-    }
-
-    // Speed factor normalized to 3.0 GHz baseline
-    const speedFactor = speedGHz / 3.0;
-
-    return {
-      cores,
-      model,
-      speedGHz,
-      speedFactor: Math.round(speedFactor * 100) / 100,
-      totalMemoryGB: Math.round(os.totalmem() / 1024 / 1024 / 1024 * 10) / 10
-    };
-  }
-
-  /**
-   * Calculate core-hours contribution
-   * @param {number} usagePercent - CPU usage percentage (0-100)
-   * @param {number} hours - Time in hours
-   */
-  calculateCoreHours(usagePercent, hours) {
-    const { cores, speedFactor } = this.cpuInfo;
-    return cores * speedFactor * (usagePercent / 100) * hours;
-  }
-
-  /**
-   * Determine tier based on core-hours and minimum cores
-   */
-  determineTier(coreHours) {
-    const { cores } = this.cpuInfo;
-
-    // Check from highest to lowest tier
-    if (cores >= TIERS.ENTERPRISE.minCores && coreHours >= TIERS.ENTERPRISE.coreHours) {
-      return TIERS.ENTERPRISE;
-    }
-    if (cores >= TIERS.BUSINESS.minCores && coreHours >= TIERS.BUSINESS.coreHours) {
-      return TIERS.BUSINESS;
-    }
-    if (cores >= TIERS.PRO.minCores && coreHours >= TIERS.PRO.coreHours) {
-      return TIERS.PRO;
-    }
-    if (cores >= TIERS.BASIC.minCores && coreHours >= TIERS.BASIC.coreHours) {
-      return TIERS.BASIC;
-    }
-    if (cores >= TIERS.STARTER.minCores && coreHours >= TIERS.STARTER.coreHours) {
-      return TIERS.STARTER;
-    }
-
-    return null; // Not enough cores or core-hours
-  }
-
-  /**
-   * Start the worker
-   */
-  async start() {
-    this.running = true;
-    this.startTime = Date.now();
-
-    // Print banner
-    console.log('');
-    console.log('  ╔═══════════════════════════════════════════════════════════════════╗');
-    console.log('  ║              AVALW Search Worker v1.1.0                           ║');
-    console.log('  ╠═══════════════════════════════════════════════════════════════════╣');
-    console.log('  ║  Free Search API in exchange for compute                          ║');
-    console.log('  ╚═══════════════════════════════════════════════════════════════════╝');
-    console.log('');
-
-    // Print system info
-    console.log('  System Info:');
-    console.log(`  ├─ CPU: ${this.cpuInfo.model}`);
-    console.log(`  ├─ Cores: ${this.cpuInfo.cores}`);
-    console.log(`  ├─ Speed: ${this.cpuInfo.speedGHz} GHz (factor: ${this.cpuInfo.speedFactor}x)`);
-    console.log(`  └─ Memory: ${this.cpuInfo.totalMemoryGB} GB`);
-    console.log('');
-
-    // Check minimum cores requirement
-    if (this.cpuInfo.cores < TIERS.STARTER.minCores) {
-      console.log(`  ⚠ WARNING: Your system has ${this.cpuInfo.cores} cores.`);
-      console.log(`  ⚠ Minimum ${TIERS.STARTER.minCores} cores required for Starter tier.`);
-      console.log(`  ⚠ Worker will run but you won't qualify for any tier.`);
-      console.log('');
-    }
-
-    // Print worker status
-    console.log('  Worker Status:');
-    console.log(`  ├─ Token: ${this.token.substring(0, 12)}...`);
-    console.log(`  ├─ API URL: ${this.apiUrl}`);
-    console.log(`  └─ Target Usage: 50%`);
-    console.log('');
-
-    // Initial heartbeat
-    await this.sendHeartbeat();
-
-    // Start heartbeat loop (every 30 seconds)
-    this.heartbeatInterval = setInterval(() => {
-      if (this.running) {
-        this.sendHeartbeat();
-      }
-    }, 30000);
-
-    console.log('  Press Ctrl+C to stop.');
-    console.log('');
-  }
-
-  /**
-   * Stop the worker
-   */
-  async stop() {
-    this.running = false;
-
-    if (this.heartbeatInterval) {
-      clearInterval(this.heartbeatInterval);
-      this.heartbeatInterval = null;
-    }
-
-    // Notify server we're going offline
-    try {
-      await this.apiRequest('/api/worker/offline', 'POST', {
-        worker_token: this.token
-      });
-      console.log('');
-      console.log('  Worker stopped and marked offline.');
-    } catch (error) {
-      // Ignore errors during shutdown
-    }
-  }
-
-  /**
-   * Send heartbeat to server with core-hours data
-   */
-  async sendHeartbeat() {
-    try {
-      // Calculate hours online since start
-      const hoursOnline = (Date.now() - this.startTime) / 1000 / 60 / 60;
-
-      // Estimate core-hours (assuming 50% usage for now)
-      // In a real implementation, you'd measure actual CPU usage
-      const estimatedUsage = 50;
-      const sessionCoreHours = this.calculateCoreHours(estimatedUsage, hoursOnline);
-
-      const response = await this.apiRequest('/api/worker/heartbeat', 'POST', {
-        worker_token: this.token,
-        system_info: {
-          platform: os.platform(),
-          arch: os.arch(),
-          cores: this.cpuInfo.cores,
-          cpu_model: this.cpuInfo.model,
-          cpu_speed_ghz: this.cpuInfo.speedGHz,
-          speed_factor: this.cpuInfo.speedFactor,
-          total_memory_gb: this.cpuInfo.totalMemoryGB,
-          free_memory_gb: Math.round(os.freemem() / 1024 / 1024 / 1024 * 10) / 10,
-          uptime: os.uptime(),
-          worker_uptime_hours: Math.round(hoursOnline * 100) / 100,
-          session_core_hours: Math.round(sessionCoreHours * 100) / 100,
-          estimated_usage_percent: estimatedUsage
-        }
-      });
-
-      if (response.success) {
-        this.coreHoursToday = response.core_hours_today || sessionCoreHours;
-        this.currentTier = response.tier || this.determineTier(this.coreHoursToday);
-
-        const time = new Date().toLocaleTimeString();
-        const tierName = this.currentTier?.name || 'None';
-        const tierRequests = this.currentTier?.requests?.toLocaleString() || '0';
-        const nextTier = this.getNextTier();
-
-        console.log(`  [${time}] ✓ Heartbeat OK`);
-        console.log(`  ├─ Core-Hours Today: ${this.coreHoursToday.toFixed(1)}${nextTier ? ` / ${nextTier.coreHours} needed for ${nextTier.name}` : ''}`);
-        console.log(`  ├─ Current Tier: ${tierName} (${tierRequests} req/day)`);
-        console.log(`  ├─ Usage Today: ${(response.usage_today || 0).toLocaleString()} / ${tierRequests}`);
-        console.log(`  └─ Online: ${this.formatUptime(hoursOnline)}`);
-        console.log('');
-      } else {
-        console.error(`  [ERROR] Heartbeat failed: ${response.error}`);
-      }
-    } catch (error) {
-      console.error(`  [ERROR] Heartbeat error: ${error.message}`);
-    }
-  }
-
-  /**
-   * Get the next tier to aim for
-   */
-  getNextTier() {
-    const tierOrder = [TIERS.STARTER, TIERS.BASIC, TIERS.PRO, TIERS.BUSINESS, TIERS.ENTERPRISE];
-
-    for (const tier of tierOrder) {
-      if (this.cpuInfo.cores >= tier.minCores && this.coreHoursToday < tier.coreHours) {
-        return tier;
-      }
-    }
-
-    return null; // Already at max tier or can't qualify
-  }
-
-  /**
-   * Format uptime as human readable
-   */
-  formatUptime(hours) {
-    if (hours < 1) {
-      return `${Math.round(hours * 60)}m`;
-    }
-    const h = Math.floor(hours);
-    const m = Math.round((hours - h) * 60);
-    return `${h}h ${m}m`;
-  }
-
-  /**
-   * Get system information (legacy method for compatibility)
-   */
-  getSystemInfo() {
-    return {
-      platform: os.platform(),
-      arch: os.arch(),
-      cpus: this.cpuInfo.cores,
-      cpu_model: this.cpuInfo.model,
-      cpu_speed_ghz: this.cpuInfo.speedGHz,
-      speed_factor: this.cpuInfo.speedFactor,
-      total_memory: this.cpuInfo.totalMemoryGB,
-      free_memory: Math.round(os.freemem() / 1024 / 1024 / 1024 * 10) / 10,
-      uptime: os.uptime()
-    };
-  }
-
-  /**
-   * Make API request
-   */
-  apiRequest(endpoint, method = 'GET', body = null) {
-    return new Promise((resolve, reject) => {
-      const url = new URL(`${this.apiUrl}${endpoint}`);
-      const isHttps = url.protocol === 'https:';
-      const lib = isHttps ? https : http;
-
-      const options = {
-        hostname: url.hostname,
-        port: url.port || (isHttps ? 443 : 80),
-        path: url.pathname,
-        method: method,
-        headers: {
-          'Content-Type': 'application/json',
-          'User-Agent': 'AvalwWorker/1.1.0'
-        }
-      };
-
-      const req = lib.request(options, (res) => {
-        let data = '';
-        res.on('data', chunk => data += chunk);
-        res.on('end', () => {
-          try {
-            resolve(JSON.parse(data));
-          } catch (e) {
-            resolve({ raw: data });
-          }
-        });
-      });
-
-      req.on('error', reject);
-      req.setTimeout(15000, () => {
-        req.destroy();
-        reject(new Error('Request timeout'));
-      });
-
-      if (body) {
-        req.write(JSON.stringify(body));
-      }
-      req.end();
-    });
-  }
-}
-
-module.exports = { AvalwWorker, TIERS };