@webcrawl/client 1.3.7 → 1.3.8

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { ApiResponse, CrawlParams, ExtractParams, MapParams, ParseParams, ParseResponse, RerankParams, ScrapeParams, SearchParams, SearchResponse } from "./types.js";
+import type { ApiResponse, CrawlParams, ExtractParams, MapParams, MonitorParams, MonitorResponse, MonitorUpdateParams, ParseParams, ParseResponse, RerankParams, ScrapeParams, SearchParams, SearchResponse } from "./types.js";
 export interface ClientOptions {
     apiKey?: string;
     baseUrl?: string;
@@ -18,7 +18,7 @@ export declare class WebcrawlClient {
     private readonly userAgent;
     private readonly timezone?;
     constructor(opts?: ClientOptions);
-    request<T = ApiResponse>(method: "GET" | "POST", path: string, body?: unknown): Promise<T>;
+    request<T = ApiResponse>(method: "GET" | "POST" | "PATCH" | "DELETE", path: string, body?: unknown): Promise<T>;
     search(p: SearchParams): Promise<SearchResponse>;
     scrape(p: ScrapeParams): Promise<ApiResponse>;
     /** PDF, DOCX/XLSX/PPTX, image or audio/video to Markdown. Long files: pass `async: true` and poll `run()`. */
@@ -32,6 +32,18 @@ export declare class WebcrawlClient {
     categories(): Promise<ApiResponse>;
     targets(): Promise<ApiResponse>;
     usage(): Promise<ApiResponse>;
+    /** List all web monitors on the account. */
+    monitors(): Promise<MonitorResponse>;
+    /** Fetch a single web monitor by ID, including its latest snapshot and per-URL state. */
+    getMonitor(id: string): Promise<MonitorResponse>;
+    /** Create a new web monitor (single page, multi-URL list, or whole website section) and run its initial check. */
+    createMonitor(p: MonitorParams): Promise<MonitorResponse>;
+    /** Trigger an immediate live check on an existing web monitor, evaluating its condition and diffing against the prior snapshot. */
+    checkMonitor(id: string): Promise<MonitorResponse>;
+    /** Update a monitor's status (`active` | `paused`), interval, watch goal, trigger condition, or notification channels. */
+    updateMonitor(p: MonitorUpdateParams): Promise<MonitorResponse>;
+    /** Delete a web monitor by ID. */
+    deleteMonitor(id: string): Promise<MonitorResponse>;
     /** Send a 6-digit OTP verification code to an email address to sign up or log in (provisions 1,000 free monthly credits). */
     sendOtp(email: string): Promise<{
         success: boolean;

package/dist/client.js

@@ -187,6 +187,45 @@ export class WebcrawlClient {
     usage() {
         return this.request("GET", "/v1/account/usage");
     }
+    /** List all web monitors on the account. */
+    monitors() {
+        return this.request("GET", "/v1/monitors");
+    }
+    /** Fetch a single web monitor by ID, including its latest snapshot and per-URL state. */
+    getMonitor(id) {
+        return this.request("GET", `/v1/monitors/${encodeURIComponent(id)}`);
+    }
+    /** Create a new web monitor (single page, multi-URL list, or whole website section) and run its initial check. */
+    createMonitor(p) {
+        const primaryUrl = p.url ?? p.urls?.[0];
+        if (!primaryUrl) {
+            throw new WebcrawlError("bad_request", "createMonitor requires `url` or non-empty `urls`");
+        }
+        return this.request("POST", "/v1/monitors", compact({
+            ...p,
+            url: primaryUrl,
+            maxPages: p.maxPages === undefined ? undefined : Math.min(25, Math.max(1, p.maxPages)),
+        }));
+    }
+    /** Trigger an immediate live check on an existing web monitor, evaluating its condition and diffing against the prior snapshot. */
+    checkMonitor(id) {
+        return this.request("POST", `/v1/monitors/${encodeURIComponent(id)}/check`, {});
+    }
+    /** Update a monitor's status (`active` | `paused`), interval, watch goal, trigger condition, or notification channels. */
+    updateMonitor(p) {
+        const { id, ...rest } = p;
+        if (!id) {
+            throw new WebcrawlError("bad_request", "updateMonitor requires `id`");
+        }
+        return this.request("PATCH", `/v1/monitors/${encodeURIComponent(id)}`, compact(rest));
+    }
+    /** Delete a web monitor by ID. */
+    deleteMonitor(id) {
+        if (!id) {
+            throw new WebcrawlError("bad_request", "deleteMonitor requires `id`");
+        }
+        return this.request("DELETE", `/v1/monitors/${encodeURIComponent(id)}`);
+    }
     /** Send a 6-digit OTP verification code to an email address to sign up or log in (provisions 1,000 free monthly credits). */
     sendOtp(email) {
         return this.request("POST", "/v1/auth/otp/send", { email: email.trim() });

package/dist/types.d.ts

@@ -124,3 +124,72 @@ export interface RerankParams {
     documents: RerankDocument[];
     topK?: number;
 }
+export type MonitorScopeMode = "page" | "urls" | "site";
+export interface MonitorParams {
+    /** Primary URL to watch (or site root URL when `mode: "site"`). */
+    url?: string;
+    /** Multiple URLs to watch when `mode: "urls"`. */
+    urls?: string[];
+    /** Watch scope: single `"page"` (default), `"urls"` list, or whole `"site"`. */
+    mode?: MonitorScopeMode;
+    /** Max pages to sample in `"site"` mode (1..25, default 5). */
+    maxPages?: number;
+    /** Optional friendly name for the watch. */
+    name?: string;
+    /** Poll interval in minutes (5..10080, default 60). */
+    intervalMinutes?: number;
+    /** Natural-language focus describing what to watch for (e.g. "Pricing tiers and discounts"). */
+    watchFor?: string;
+    /** Trigger condition expression (e.g. `'price < 50'`, `'content contains "In Stock"'`) or condition AST object. */
+    condition?: string | Record<string, unknown>;
+    /** Email address to alert when triggered, or `true` to use the signed-in account email. */
+    notifyEmail?: string | boolean;
+    /** HTTPS webhook URL to POST when triggered. */
+    webhookUrl?: string;
+}
+export interface MonitorUpdateParams {
+    id: string;
+    name?: string | null;
+    status?: "active" | "paused";
+    intervalMinutes?: number;
+    watchFor?: string | null;
+    condition?: string | Record<string, unknown> | null;
+    notifyEmail?: string | boolean | null;
+    webhookUrl?: string | null;
+    urls?: string[];
+    maxPages?: number;
+}
+export interface MonitorRecord {
+    id: string;
+    name?: string | null;
+    mode?: MonitorScopeMode;
+    url: string;
+    urls?: string[];
+    maxPages?: number;
+    watchFor?: string | null;
+    condition?: Record<string, unknown> | null;
+    conditionJev?: string | null;
+    notifyEmail?: string | null;
+    webhookUrl?: string | null;
+    intervalMinutes: number;
+    status: "active" | "paused";
+    lastContentHash?: string | null;
+    lastTitle?: string | null;
+    lastSnapshot?: string | null;
+    lastDiffSummary?: string | null;
+    lastConditionMet?: boolean | null;
+    lastNotificationStatus?: string | null;
+    changeCount?: number;
+    lastCheckedAt?: string | null;
+    lastChangeDetectedAt?: string | null;
+    createdAt?: string;
+    [key: string]: unknown;
+}
+export interface MonitorResponse extends ApiResponse {
+    monitor?: MonitorRecord;
+    monitors?: MonitorRecord[];
+    initialCheck?: Record<string, unknown>;
+    check?: Record<string, unknown>;
+    notifications?: Record<string, unknown>;
+    deleted?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webcrawl/client",
-  "version": "1.3.7",
+  "version": "1.3.8",
   "description": "Zero-dependency TypeScript & Node.js SDK for Webcrawl Anything (search, scrape, parse, map, crawl, extract, rerank, targets)",
   "type": "module",
   "license": "MIT",