Supercharge your AI agents with data from the web and beyond. Building the library for superintelligence. 🔥
TypeScript aiai-agentsai-crawlerai-scrapingai-searchcrawlerdata-extractionhtml-to-markdownllmmarkdownscraperscrapingweb-crawlerweb-dataweb-data-extractionweb-scraperweb-scrapingweb-searchwebscraping
Add search monitor target types and tests
Developers Digest8ab2ce00302b
diff --git a/apps/api/src/services/monitoring/search/run-defenses.test.ts b/apps/api/src/services/monitoring/search/run-defenses.test.tsindex 694f7fff3..c6b5fbb17 100644--- a/apps/api/src/services/monitoring/search/run-defenses.test.ts+++ b/apps/api/src/services/monitoring/search/run-defenses.test.ts@@ -1,3 +1,4 @@+/// <reference types="jest" />jest.mock("uuid", () => ({ v7: () => "00000000-0000-7000-8000-000000000000" }));import type { Logger } from "winston";diff --git a/apps/api/src/services/monitoring/search/run.test.ts b/apps/api/src/services/monitoring/search/run.test.tsindex 2f6a32b21..b778e4d4d 100644--- a/apps/api/src/services/monitoring/search/run.test.ts+++ b/apps/api/src/services/monitoring/search/run.test.ts@@ -1,3 +1,4 @@+/// <reference types="jest" />jest.mock("uuid", () => ({ v7: () => "00000000-0000-7000-8000-000000000000" }));import type { Logger } from "winston";diff --git a/apps/js-sdk/firecrawl/src/__tests__/unit/v2/monitor-search-target.test.ts b/apps/js-sdk/firecrawl/src/__tests__/unit/v2/monitor-search-target.test.tsnew file mode 100644index 000000000..ff86b38a9--- /dev/null+++ b/apps/js-sdk/firecrawl/src/__tests__/unit/v2/monitor-search-target.test.ts@@ -0,0 +1,41 @@+/**+ * Unit test: a search-target monitor request is forwarded intact to the API.+ */+import { createMonitor } from "../../../v2/methods/monitor";+import type { CreateMonitorRequest, MonitorSearchTarget } from "../../../v2/types";++describe("v2 monitor search target", () => {+ test("createMonitor forwards a search target with its camelCase fields", async () => {+ let captured: any;+ const http: any = {+ post: async (_path: string, body: any) => {+ captured = body;+ return { status: 200, data: { success: true, data: { id: "mon_1", ...body } } };+ },+ };++ const searchTarget: MonitorSearchTarget = {+ type: "search",+ queries: ["firecrawl launch"],+ searchWindow: "24h",+ includeDomains: ["firecrawl.dev"],+ excludeDomains: ["spam.com"],+ recheckAfter: "6h",+ maxResults: 20,+ };++ const request: CreateMonitorRequest = {+ name: "Search monitor",+ schedule: { text: "every 30 minutes" },+ goal: "Alert when Firecrawl launches a product",+ targets: [searchTarget],+ };++ await createMonitor(http, request);++ expect(captured.targets[0]).toEqual(searchTarget);+ expect(captured.targets[0].type).toBe("search");+ expect(captured.targets[0].searchWindow).toBe("24h");+ expect(captured.targets[0].maxResults).toBe(20);+ });+});diff --git a/apps/js-sdk/firecrawl/src/v2/types.ts b/apps/js-sdk/firecrawl/src/v2/types.tsindex 9580c7764..66bd8a4cd 100644--- a/apps/js-sdk/firecrawl/src/v2/types.ts+++ b/apps/js-sdk/firecrawl/src/v2/types.ts@@ -772,7 +772,22 @@ export interface MonitorCrawlTarget {scrapeOptions?: ScrapeOptions;}-export type MonitorTarget = MonitorScrapeTarget | MonitorCrawlTarget;+export interface MonitorSearchTarget {+ id?: string;+ type: "search";+ queries: string[];+ searchWindow?: "5m" | "15m" | "1h" | "6h" | "24h" | "7d";+ includeDomains?: string[];+ excludeDomains?: string[];+ recheckAfter?: "1h" | "6h" | "24h" | "7d";+ maxResults?: number;+ scrapeOptions?: ScrapeOptions;+}++export type MonitorTarget =+ | MonitorScrapeTarget+ | MonitorCrawlTarget+ | MonitorSearchTarget;export interface CreateMonitorRequest {name: string;diff --git a/apps/python-sdk/firecrawl/__tests__/unit/v2/test_monitor_types.py b/apps/python-sdk/firecrawl/__tests__/unit/v2/test_monitor_types.pyindex 9d6388f62..247e62e2b 100644--- a/apps/python-sdk/firecrawl/__tests__/unit/v2/test_monitor_types.py+++ b/apps/python-sdk/firecrawl/__tests__/unit/v2/test_monitor_types.py@@ -1,4 +1,52 @@-from firecrawl.v2.types import MonitorPageJudgment+from firecrawl.v2.types import MonitorCreateRequest, MonitorPageJudgment, MonitorTarget+++def test_monitor_search_target_parses_camelcase_fields():+ target = MonitorTarget.model_validate(+ {+ "type": "search",+ "queries": ["firecrawl launch"],+ "searchWindow": "24h",+ "includeDomains": ["firecrawl.dev"],+ "excludeDomains": ["spam.com"],+ "recheckAfter": "6h",+ "maxResults": 20,+ }+ )++ assert target.type == "search"+ assert target.queries == ["firecrawl launch"]+ assert target.search_window == "24h"+ assert target.include_domains == ["firecrawl.dev"]+ assert target.exclude_domains == ["spam.com"]+ assert target.recheck_after == "6h"+ assert target.max_results == 20+++def test_monitor_create_request_serializes_search_target_to_camelcase():+ request = MonitorCreateRequest(+ name="Search monitor",+ schedule={"text": "every 30 minutes"},+ goal="Alert when Firecrawl launches a product",+ targets=[+ MonitorTarget(+ type="search",+ queries=["firecrawl launch"],+ search_window="24h",+ max_results=15,+ )+ ],+ )++ payload = request.model_dump(exclude_none=True, by_alias=True)+ target = payload["targets"][0]+ assert target["type"] == "search"+ assert target["queries"] == ["firecrawl launch"]+ assert target["searchWindow"] == "24h"+ assert target["maxResults"] == 15+ # internal-only fields are never emitted by the SDK+ assert "depth" not in target+ assert "alertMode" not in targetdef test_monitor_page_judgment_parses_meaningful_changes():diff --git a/apps/python-sdk/firecrawl/v2/types.py b/apps/python-sdk/firecrawl/v2/types.pyindex 8dcec63d2..4d9b73e8d 100644--- a/apps/python-sdk/firecrawl/v2/types.py+++ b/apps/python-sdk/firecrawl/v2/types.py@@ -985,16 +985,23 @@ class MonitorEmailRecipientSubscription(BaseModel):class MonitorTarget(BaseModel):- """A scrape or crawl target stored on a monitor."""+ """A scrape, crawl, or search target stored on a monitor."""model_config = {"extra": "allow", "populate_by_name": True}id: Optional[str] = None- type: Literal["scrape", "crawl"]+ type: Literal["scrape", "crawl", "search"]urls: Optional[List[str]] = Noneurl: Optional[str] = Nonescrape_options: Optional[Union[ScrapeOptions, Dict[str, Any]]] = Field(default=None, alias="scrapeOptions")crawl_options: Optional[Dict[str, Any]] = Field(default=None, alias="crawlOptions")+ # search target fields+ queries: Optional[List[str]] = None+ search_window: Optional[Literal["5m", "15m", "1h", "6h", "24h", "7d"]] = Field(default=None, alias="searchWindow")+ include_domains: Optional[List[str]] = Field(default=None, alias="includeDomains")+ exclude_domains: Optional[List[str]] = Field(default=None, alias="excludeDomains")+ recheck_after: Optional[Literal["1h", "6h", "24h", "7d"]] = Field(default=None, alias="recheckAfter")+ max_results: Optional[int] = Field(default=None, alias="maxResults")class MonitorCreateRequest(BaseModel):