felo-ai 0.2.6 → 0.2.9

package/tests/search.test.js

@@ -1,100 +1,100 @@
-import { describe, it, before, after } from 'node:test';
-import assert from 'node:assert';
-import path from 'path';
-import os from 'os';
-import fs from 'fs/promises';
-
-const tmpDir = path.join(os.tmpdir(), `felo-test-search-${Date.now()}`);
-const testConfigFile = path.join(tmpDir, 'config.json');
-process.env.FELO_CONFIG_FILE = testConfigFile;
-
-import { getApiKey, fetchWithTimeoutAndRetry } from '../src/search.js';
-import * as config from '../src/config.js';
-
-after(async () => {
-  delete process.env.FELO_API_KEY;
-  delete process.env.FELO_CONFIG_FILE;
-  await fs.rm(tmpDir, { recursive: true, force: true }).catch(() => {});
-});
-
-before(async () => {
-  await fs.mkdir(path.dirname(testConfigFile), { recursive: true });
-});
-
-describe('getApiKey', () => {
-  it('returns env FELO_API_KEY when set', async () => {
-    process.env.FELO_API_KEY = 'env-key';
-    const key = await getApiKey();
-    assert.strictEqual(key, 'env-key');
-  });
-
-  it('returns key from config when env not set', async () => {
-    delete process.env.FELO_API_KEY;
-    await config.setConfig('FELO_API_KEY', 'config-key');
-    const key = await getApiKey();
-    assert.strictEqual(key, 'config-key');
-  });
-
-  it('returns empty string when neither set', async () => {
-    delete process.env.FELO_API_KEY;
-    await config.unsetConfig('FELO_API_KEY');
-    const key = await getApiKey();
-    assert.strictEqual(key, '');
-  });
-
-  it('env wins over config', async () => {
-    process.env.FELO_API_KEY = 'env-wins';
-    await config.setConfig('FELO_API_KEY', 'config-key');
-    const key = await getApiKey();
-    assert.strictEqual(key, 'env-wins');
-  });
-});
-
-describe('fetchWithTimeoutAndRetry', () => {
-  it('returns response on 200', async () => {
-    const res = { ok: true, status: 200 };
-    let callCount = 0;
-    const origFetch = globalThis.fetch;
-    globalThis.fetch = () => { callCount++; return Promise.resolve(res); };
-    try {
-      const out = await fetchWithTimeoutAndRetry('https://example.com', {}, 10_000);
-      assert.strictEqual(out, res);
-      assert.strictEqual(callCount, 1);
-    } finally {
-      globalThis.fetch = origFetch;
-    }
-  });
-
-  it('retries on 500 then succeeds', async () => {
-    const res200 = { ok: true, status: 200 };
-    const res500 = { ok: false, status: 502 };
-    let callCount = 0;
-    const origFetch = globalThis.fetch;
-    globalThis.fetch = () => {
-      callCount++;
-      return Promise.resolve(callCount === 1 ? res500 : res200);
-    };
-    try {
-      const out = await fetchWithTimeoutAndRetry('https://example.com', {}, 10_000);
-      assert.strictEqual(out, res200);
-      assert.strictEqual(callCount, 2);
-    } finally {
-      globalThis.fetch = origFetch;
-    }
-  });
-
-  it('throws on timeout (AbortError)', async () => {
-    const origFetch = globalThis.fetch;
-    const abortErr = new Error('The operation was aborted');
-    abortErr.name = 'AbortError';
-    globalThis.fetch = () => Promise.reject(abortErr);
-    try {
-      await assert.rejects(
-        async () => fetchWithTimeoutAndRetry('https://example.com', {}, 5000),
-        (err) => err.message && err.message.includes('timed out')
-      );
-    } finally {
-      globalThis.fetch = origFetch;
-    }
-  });
-});
+import { describe, it, before, after } from 'node:test';
+import assert from 'node:assert';
+import path from 'path';
+import os from 'os';
+import fs from 'fs/promises';
+
+const tmpDir = path.join(os.tmpdir(), `felo-test-search-${Date.now()}`);
+const testConfigFile = path.join(tmpDir, 'config.json');
+process.env.FELO_CONFIG_FILE = testConfigFile;
+
+import { getApiKey, fetchWithTimeoutAndRetry } from '../src/search.js';
+import * as config from '../src/config.js';
+
+after(async () => {
+  delete process.env.FELO_API_KEY;
+  delete process.env.FELO_CONFIG_FILE;
+  await fs.rm(tmpDir, { recursive: true, force: true }).catch(() => {});
+});
+
+before(async () => {
+  await fs.mkdir(path.dirname(testConfigFile), { recursive: true });
+});
+
+describe('getApiKey', () => {
+  it('returns env FELO_API_KEY when set', async () => {
+    process.env.FELO_API_KEY = 'env-key';
+    const key = await getApiKey();
+    assert.strictEqual(key, 'env-key');
+  });
+
+  it('returns key from config when env not set', async () => {
+    delete process.env.FELO_API_KEY;
+    await config.setConfig('FELO_API_KEY', 'config-key');
+    const key = await getApiKey();
+    assert.strictEqual(key, 'config-key');
+  });
+
+  it('returns empty string when neither set', async () => {
+    delete process.env.FELO_API_KEY;
+    await config.unsetConfig('FELO_API_KEY');
+    const key = await getApiKey();
+    assert.strictEqual(key, '');
+  });
+
+  it('env wins over config', async () => {
+    process.env.FELO_API_KEY = 'env-wins';
+    await config.setConfig('FELO_API_KEY', 'config-key');
+    const key = await getApiKey();
+    assert.strictEqual(key, 'env-wins');
+  });
+});
+
+describe('fetchWithTimeoutAndRetry', () => {
+  it('returns response on 200', async () => {
+    const res = { ok: true, status: 200 };
+    let callCount = 0;
+    const origFetch = globalThis.fetch;
+    globalThis.fetch = () => { callCount++; return Promise.resolve(res); };
+    try {
+      const out = await fetchWithTimeoutAndRetry('https://example.com', {}, 10_000);
+      assert.strictEqual(out, res);
+      assert.strictEqual(callCount, 1);
+    } finally {
+      globalThis.fetch = origFetch;
+    }
+  });
+
+  it('retries on 500 then succeeds', async () => {
+    const res200 = { ok: true, status: 200 };
+    const res500 = { ok: false, status: 502 };
+    let callCount = 0;
+    const origFetch = globalThis.fetch;
+    globalThis.fetch = () => {
+      callCount++;
+      return Promise.resolve(callCount === 1 ? res500 : res200);
+    };
+    try {
+      const out = await fetchWithTimeoutAndRetry('https://example.com', {}, 10_000);
+      assert.strictEqual(out, res200);
+      assert.strictEqual(callCount, 2);
+    } finally {
+      globalThis.fetch = origFetch;
+    }
+  });
+
+  it('throws on timeout (AbortError)', async () => {
+    const origFetch = globalThis.fetch;
+    const abortErr = new Error('The operation was aborted');
+    abortErr.name = 'AbortError';
+    globalThis.fetch = () => Promise.reject(abortErr);
+    try {
+      await assert.rejects(
+        async () => fetchWithTimeoutAndRetry('https://example.com', {}, 5000),
+        (err) => err.message && err.message.includes('timed out')
+      );
+    } finally {
+      globalThis.fetch = origFetch;
+    }
+  });
+});

package/felo-web-extract/README.md

@@ -1,78 +0,0 @@
-# Felo Web Extract Skill
-
-Extract webpage content from a URL using the [Felo Web Extract API](https://openapi.felo.ai/docs/api-reference/v2/web-extract.html).
-
-## Features
-
-- Extract content from any URL as **html**, **text**, or **markdown** (`--format`)
-- **Target one element** with a CSS selector (`--target-selector`, e.g. `article.main`, `#content`)
-- Optional **readability** mode for main article content only
-- Crawl modes: `fast` (default) or `fine`
-- Same `FELO_API_KEY` as other Felo skills
-
-## Quick Start
-
-### 1) Configure API key
-
-At [felo.ai](https://felo.ai) -> Settings -> API Keys, create a key, then:
-
-```bash
-# Linux/macOS
-export FELO_API_KEY="your-api-key-here"
-```
-
-```powershell
-# Windows PowerShell
-$env:FELO_API_KEY="your-api-key-here"
-```
-
-### 2) Run extraction
-
-```bash
-# Extract as Markdown (default)
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com/article"
-
-# With readability for clean article text
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com" --readability --format markdown
-
-# Full JSON response
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com" --json
-
-# Only a specific element (CSS selector) and output format
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com" --target-selector "article.main" --format markdown
-```
-
-## Using the packaged CLI (`felo web-extract`)
-
-After `npm install -g felo-ai`, you can run:
-
-```bash
-felo web-extract --url "https://example.com"
-```
-
-**All parameters (how to pass)**
-
-| Parameter | Option | Example |
-|-----------|--------|---------|
-| URL (required) | `-u`, `--url` | `--url "https://example.com"` |
-| Output format | `-f`, `--format` | `--format text`, `-f markdown`, `-f html` |
-| Target element (CSS selector) | `--target-selector` | `--target-selector "article.main"` |
-| Wait for selector | `--wait-for-selector` | `--wait-for-selector ".content"` |
-| Readability (main content only) | `--readability` | `--readability` |
-| Crawl mode | `--crawl-mode` | `--crawl-mode fine` (default: `fast`) |
-| Timeout (seconds) | `-t`, `--timeout` | `--timeout 120`, `-t 90` |
-| Full JSON response | `-j`, `--json` | `-j` or `--json` |
-
-**Examples with multiple options**
-
-```bash
-felo web-extract -u "https://example.com" -f text --readability
-felo web-extract --url "https://example.com" --target-selector "#content" --format markdown --timeout 90
-felo web-extract --url "https://example.com" --wait-for-selector "main" --readability -j
-```
-
-## When to use (Agent)
-
-Trigger keywords: extract webpage, scrape URL, fetch page content, url to markdown, `/felo-web-extract`.
-
-See [SKILL.md](SKILL.md) for full agent instructions and API parameters.

package/felo-web-extract/SKILL.md

@@ -1,200 +0,0 @@
----
-name: felo-web-extract
-description: "Extract web page content from a URL using Felo Web Extract API. Use when users ask to scrape/capture/fetch webpage content, extract article text from URL, convert page to markdown/text, or when explicit commands like /felo-web-extract are used. Supports html, text, markdown output and readability mode."
----
-
-# Felo Web Extract Skill
-
-## When to Use
-
-Trigger this skill when the user wants to:
-
-- Extract or scrape content from a webpage URL
-- Get article/main text from a link
-- Convert a webpage to Markdown or plain text
-- Capture readable content from a URL for summarization or processing
-
-Trigger keywords (examples):
-
-- extract webpage, scrape URL, fetch page content, web extract, url to markdown
-- Explicit: `/felo-web-extract`, "use felo web extract"
-- Same intent in other languages (e.g. 网页抓取, 提取网页内容) also triggers this skill
-
-Do NOT use for:
-
-- Real-time search or Q&A (use `felo-search`)
-- Generating slides (use `felo-slides`)
-- Local file content (read files directly)
-
-## Setup
-
-### 1. Get API key
-
-1. Visit [felo.ai](https://felo.ai)
-2. Open Settings -> API Keys
-3. Create and copy your API key
-
-### 2. Configure environment variable
-
-Linux/macOS:
-
-```bash
-export FELO_API_KEY="your-api-key-here"
-```
-
-Windows PowerShell:
-
-```powershell
-$env:FELO_API_KEY="your-api-key-here"
-```
-
-## How to Execute
-
-### Option A: Use the bundled script or packaged CLI
-
-**Script** (from repo):
-
-```bash
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com/article" [options]
-```
-
-**Packaged CLI** (after `npm install -g felo-ai`): same options, with short forms allowed:
-
-```bash
-felo web-extract -u "https://example.com" [options]
-# Short forms: -u (url), -f (format), -t (timeout, seconds), -j (json)
-```
-
-Options:
-
-| Option | Default | Description |
-|--------|---------|-------------|
-| `--url` | (required) | Webpage URL to extract |
-| `--format` | markdown | Output format: `html`, `text`, `markdown` |
-| `--target-selector` | - | CSS selector: extract only this element (e.g. `article.main`, `#content`) |
-| `--wait-for-selector` | - | Wait for this selector before extracting (e.g. dynamic content) |
-| `--readability` | false | Enable readability processing (main content only) |
-| `--crawl-mode` | fast | `fast` or `fine` |
-| `--timeout` | 60000 (script) / 60 (CLI) | Request timeout: script uses **milliseconds**, CLI uses **seconds** (e.g. `-t 90`) |
-| `--json` / `-j` | false | Print full API response as JSON |
-
-### How to write instructions (target_selector + output_format)
-
-When the user wants a **specific part** of the page or a **specific output format**, phrase the command like this:
-
-- **Output format**: "Extract as **text**" / "Get **markdown**" / "Return **html**" → use `--format text`, `--format markdown`, or `--format html`.
-- **Target one element**: "Only the **main article**" / "Just the **content inside** `#main`" / "Extract only **article.main-content**" → use `--target-selector "article.main"` or the selector they give (e.g. `#main`, `.main-content`, `article .post`).
-
-Examples of user intents and equivalent commands:
-
-| User intent | Command |
-|-------------|---------|
-| "Extract this page as plain text" | `--url "..." --format text` |
-| "Get only the main content area" | `--url "..." --target-selector "main"` or `article` |
-| "Extract the div with id=content as markdown" | `--url "..." --target-selector "#content" --format markdown` |
-| "Just the article body, as HTML" | `--url "..." --target-selector "article .body" --format html` |
-
-Examples:
-
-```bash
-# Basic: extract as Markdown
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com"
-
-# Article-style with readability
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com/article" --readability --format markdown
-
-# Raw HTML
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com" --format html --json
-
-# Only the element matching a CSS selector (e.g. main article)
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com" --target-selector "article.main" --format markdown
-
-# Specific output format + target selector
-node felo-web-extract/scripts/run_web_extract.mjs --url "https://example.com" --target-selector "#content" --format text
-```
-
-### Option B: Call API with curl
-
-```bash
-curl -X POST "https://openapi.felo.ai/v2/web/extract" \
-  -H "Authorization: Bearer $FELO_API_KEY" \
-  -H "Content-Type: application/json" \
-  -d '{"url": "https://example.com", "output_format": "markdown", "with_readability": true}'
-```
-
-## API Reference (summary)
-
-- **Endpoint**: `POST /v2/web/extract`
-- **Base URL**: `https://openapi.felo.ai`. Override with `FELO_API_BASE` env if needed.
-- **Auth**: `Authorization: Bearer YOUR_API_KEY`
-
-### Request body (JSON)
-
-| Parameter | Type | Required | Default | Description |
-|-----------|------|----------|---------|-------------|
-| url | string | Yes | - | Webpage URL to extract |
-| crawl_mode | string | No | fast | `fast` or `fine` |
-| output_format | string | No | html | `html`, `text`, `markdown` |
-| with_readability | boolean | No | - | Use readability (main content) |
-| with_links_summary | boolean | No | - | Include links summary |
-| with_images_summary | boolean | No | - | Include images summary |
-| target_selector | string | No | - | CSS selector for target element |
-| wait_for_selector | string | No | - | Wait for selector before extract |
-| timeout | integer | No | - | Timeout in milliseconds |
-| with_cache | boolean | No | true | Use cache |
-
-### Response
-
-Success (200):
-
-```json
-{
-  "code": 0,
-  "message": "success",
-  "data": {
-    "content": { ... }
-  }
-}
-```
-
-Extracted content is in `data.content`; structure depends on `output_format`.
-
-### Error codes
-
-| HTTP | Code | Description |
-|------|------|-------------|
-| 400 | - | Parameter validation failed |
-| 401 | INVALID_API_KEY | API key invalid or revoked |
-| 500/502 | WEB_EXTRACT_FAILED | Extract failed (server or page error) |
-
-## Output Format
-
-On success (script without `--json`):
-
-- Print the extracted content only (for direct use or piping).
-
-With `--json`:
-
-- Print full API response including `code`, `message`, `data`.
-
-Error response to user:
-
-```markdown
-## Web Extract Failed
-
-- Error: <code or message>
-- URL: <requested url>
-- Suggestion: <e.g. check URL, retry, or use --timeout>
-```
-
-## Important Notes
-
-- Always check `FELO_API_KEY` before calling; if missing, return setup instructions.
-- For long articles or slow sites, consider `--timeout` or `timeout` in request body.
-- Use `output_format: "markdown"` and `with_readability: true` for clean article text.
-- API may cache results; use `with_cache: false` in body only when fresh content is required (script does not expose this by default).
-
-## References
-
-- [Felo Web Extract API](https://openapi.felo.ai/docs/api-reference/v2/web-extract.html)
-- [Felo Open Platform](https://openapi.felo.ai/docs/)