firecrawl 4.21.1 → 4.22.1

package/dist/{chunk-EH7NHUN5.js → chunk-WTZQ5IMF.js}

@@ -8,7 +8,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.21.1",
+      version: "4.22.1",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -34,7 +34,7 @@ var require_package = __commonJS({
       author: "Mendable.ai",
       license: "MIT",
       dependencies: {
-        axios: "1.15.0",
+        axios: "1.15.2",
         firecrawl: "4.16.0",
         "typescript-event-target": "^1.1.1",
         zod: "^3.23.8",
@@ -78,7 +78,7 @@ var require_package = __commonJS({
           "picomatch@<4.0.4": ">=4.0.4",
           handlebars: ">=4.7.9",
           "brace-expansion": ">=5.0.5",
-          "axios@<1.15.0": "1.15.0",
+          "axios@<1.15.2": "1.15.2",
           "follow-redirects@<1.16.0": ">=1.16.0 <2.0.0"
         }
       }

package/dist/index.cjs

@@ -35,7 +35,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.21.1",
+      version: "4.22.1",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -61,7 +61,7 @@ var require_package = __commonJS({
       author: "Mendable.ai",
       license: "MIT",
       dependencies: {
-        axios: "1.15.0",
+        axios: "1.15.2",
         firecrawl: "4.16.0",
         "typescript-event-target": "^1.1.1",
         zod: "^3.23.8",
@@ -105,7 +105,7 @@ var require_package = __commonJS({
           "picomatch@<4.0.4": ">=4.0.4",
           handlebars: ">=4.7.9",
           "brace-expansion": ">=5.0.5",
-          "axios@<1.15.0": "1.15.0",
+          "axios@<1.15.2": "1.15.2",
           "follow-redirects@<1.16.0": ">=1.16.0 <2.0.0"
         }
       }
@@ -237,6 +237,15 @@ var HttpClient = class {
   delete(endpoint, headers) {
     return this.request({ method: "delete", url: endpoint, headers });
   }
+  patch(endpoint, body, options) {
+    return this.request({
+      method: "patch",
+      url: endpoint,
+      data: body,
+      headers: options?.headers,
+      timeout: options?.timeoutMs
+    });
+  }
   prepareHeaders(idempotencyKey) {
     const headers = {};
     if (idempotencyKey) headers["x-idempotency-key"] = idempotencyKey;
@@ -359,6 +368,30 @@ function ensureValidFormats(formats) {
       }
       continue;
     }
+    if (fmt.type === "question") {
+      const q = fmt;
+      if (typeof q.question !== "string" || q.question.trim().length === 0) {
+        throw new Error("question format requires a non-empty 'question' string");
+      }
+      continue;
+    }
+    if (fmt.type === "highlights") {
+      const h = fmt;
+      if (typeof h.query !== "string" || h.query.trim().length === 0) {
+        throw new Error("highlights format requires a non-empty 'query' string");
+      }
+      continue;
+    }
+    if (fmt.type === "query") {
+      const q = fmt;
+      if (typeof q.prompt !== "string" || q.prompt.trim().length === 0) {
+        throw new Error("query format requires a non-empty 'prompt' string");
+      }
+      if (q.mode != null && q.mode !== "freeform" && q.mode !== "directQuote") {
+        throw new Error("query format mode must be 'freeform' or 'directQuote'");
+      }
+      continue;
+    }
     if (fmt.type === "screenshot") {
       const s = fmt;
       if (s.quality != null && (typeof s.quality !== "number" || s.quality < 0)) {
@@ -418,6 +451,30 @@ function ensureValidParseFormats(formats) {
           "json format schema appears to be a Zod schema's .shape property. Pass the Zod schema directly (e.g., `schema: MySchema`) instead of `schema: MySchema.shape`. The SDK will automatically convert Zod schemas to JSON Schema format."
         );
       }
+      continue;
+    }
+    if (fmt.type === "question") {
+      const q = fmt;
+      if (typeof q.question !== "string" || q.question.trim().length === 0) {
+        throw new Error("question format requires a non-empty 'question' string");
+      }
+      continue;
+    }
+    if (fmt.type === "highlights") {
+      const h = fmt;
+      if (typeof h.query !== "string" || h.query.trim().length === 0) {
+        throw new Error("highlights format requires a non-empty 'query' string");
+      }
+      continue;
+    }
+    if (fmt.type === "query") {
+      const q = fmt;
+      if (typeof q.prompt !== "string" || q.prompt.trim().length === 0) {
+        throw new Error("query format requires a non-empty 'prompt' string");
+      }
+      if (q.mode != null && q.mode !== "freeform" && q.mode !== "directQuote") {
+        throw new Error("query format mode must be 'freeform' or 'directQuote'");
+      }
     }
   }
 }
@@ -759,12 +816,13 @@ async function fetchAllPages(http, nextUrl, initial, pagination) {
       break;
     }
     if (!payload?.success) break;
-    for (const d of payload.data || []) {
+    const pageData = Array.isArray(payload.data) ? payload.data : payload.data?.pages || [];
+    for (const d of pageData) {
       if (maxResults != null && docs.length >= maxResults) break;
       docs.push(d);
     }
     if (maxResults != null && docs.length >= maxResults) break;
-    current = payload.next ?? null;
+    current = payload.next ?? (Array.isArray(payload.data) ? null : payload.data?.next) ?? null;
     pageCount += 1;
   }
   return docs;
@@ -1347,6 +1405,126 @@ async function getTokenUsageHistorical(http, byApiKey) {
   }
 }
 
+// src/v2/methods/monitor.ts
+function queryString(params) {
+  if (!params) return "";
+  const query = new URLSearchParams();
+  for (const [key, value] of Object.entries(params)) {
+    if (value !== void 0 && value !== null) query.set(key, String(value));
+  }
+  const str = query.toString();
+  return str ? `?${str}` : "";
+}
+function dataOrThrow(res, action) {
+  if (res.status !== 200 || !res.data?.success || res.data.data == null) {
+    throwForBadResponse(res, action);
+  }
+  return res.data.data;
+}
+async function createMonitor(http, request) {
+  try {
+    const res = await http.post("/v2/monitor", request);
+    return dataOrThrow(res, "create monitor");
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "create monitor");
+    throw err;
+  }
+}
+async function listMonitors(http, options) {
+  try {
+    const res = await http.get(
+      `/v2/monitor${queryString(options)}`
+    );
+    return dataOrThrow(res, "list monitors");
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "list monitors");
+    throw err;
+  }
+}
+async function getMonitor(http, monitorId) {
+  try {
+    const res = await http.get(`/v2/monitor/${monitorId}`);
+    return dataOrThrow(res, "get monitor");
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "get monitor");
+    throw err;
+  }
+}
+async function updateMonitor(http, monitorId, request) {
+  try {
+    const res = await http.patch(
+      `/v2/monitor/${monitorId}`,
+      request
+    );
+    return dataOrThrow(res, "update monitor");
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "update monitor");
+    throw err;
+  }
+}
+async function deleteMonitor(http, monitorId) {
+  try {
+    const res = await http.delete(`/v2/monitor/${monitorId}`);
+    if (res.status !== 200 || !res.data?.success) {
+      throwForBadResponse(res, "delete monitor");
+    }
+    return true;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "delete monitor");
+    throw err;
+  }
+}
+async function runMonitor(http, monitorId) {
+  try {
+    const res = await http.post(
+      `/v2/monitor/${monitorId}/run`,
+      {}
+    );
+    return dataOrThrow(res, "run monitor");
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "run monitor");
+    throw err;
+  }
+}
+async function listMonitorChecks(http, monitorId, options) {
+  try {
+    const res = await http.get(
+      `/v2/monitor/${monitorId}/checks${queryString(options)}`
+    );
+    return dataOrThrow(res, "list monitor checks");
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "list monitor checks");
+    throw err;
+  }
+}
+async function getMonitorCheck(http, monitorId, checkId, options) {
+  try {
+    const { autoPaginate: _autoPaginate, maxPages: _maxPages, maxResults: _maxResults, maxWaitTime: _maxWaitTime, ...query } = options ?? {};
+    const res = await http.get(
+      `/v2/monitor/${monitorId}/checks/${checkId}${queryString(query)}`
+    );
+    const detail = dataOrThrow(res, "get monitor check");
+    const next = res.data?.next ?? detail.next ?? null;
+    const auto = options?.autoPaginate ?? true;
+    if (!auto || !next) {
+      return { ...detail, next };
+    }
+    return {
+      ...detail,
+      pages: await fetchAllPages(
+        http,
+        next,
+        detail.pages || [],
+        options
+      ),
+      next: null
+    };
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "get monitor check");
+    throw err;
+  }
+}
+
 // src/v2/watcher.ts
 var import_events = require("events");
 var hasGlobalWebSocket = () => {
@@ -1728,6 +1906,55 @@ var FirecrawlClient = class {
   async crawlParamsPreview(url, prompt) {
     return crawlParamsPreview(this.http, url, prompt);
   }
+  // Monitor
+  /**
+   * Create a scheduled monitor.
+   */
+  async createMonitor(request) {
+    return createMonitor(this.http, request);
+  }
+  /**
+   * List monitors for the authenticated team.
+   */
+  async listMonitors(options) {
+    return listMonitors(this.http, options);
+  }
+  /**
+   * Get a monitor by id.
+   */
+  async getMonitor(monitorId) {
+    return getMonitor(this.http, monitorId);
+  }
+  /**
+   * Update a monitor.
+   */
+  async updateMonitor(monitorId, request) {
+    return updateMonitor(this.http, monitorId, request);
+  }
+  /**
+   * Delete a monitor.
+   */
+  async deleteMonitor(monitorId) {
+    return deleteMonitor(this.http, monitorId);
+  }
+  /**
+   * Trigger a manual monitor check.
+   */
+  async runMonitor(monitorId) {
+    return runMonitor(this.http, monitorId);
+  }
+  /**
+   * List checks for a monitor.
+   */
+  async listMonitorChecks(monitorId, options) {
+    return listMonitorChecks(this.http, monitorId, options);
+  }
+  /**
+   * Get a monitor check with paginated page results and inline diffs.
+   */
+  async getMonitorCheck(monitorId, checkId, options) {
+    return getMonitorCheck(this.http, monitorId, checkId, options);
+  }
   // Batch
   /**
    * Start a batch scrape job for multiple URLs (async).

package/dist/index.d.cts

@@ -40,17 +40,26 @@ interface AttributesFormat extends Format {
         attribute: string;
     }>;
 }
+interface QuestionFormat {
+    type: 'question';
+    question: string;
+}
+interface HighlightsFormat {
+    type: 'highlights';
+    query: string;
+}
+/** @deprecated Use QuestionFormat or HighlightsFormat instead. */
 interface QueryFormat {
     type: 'query';
     prompt: string;
     mode?: 'freeform' | 'directQuote';
 }
-type FormatOption = FormatString | Format | JsonFormat | ChangeTrackingFormat | ScreenshotFormat | AttributesFormat | QueryFormat;
+type FormatOption = FormatString | Format | JsonFormat | ChangeTrackingFormat | ScreenshotFormat | AttributesFormat | QuestionFormat | HighlightsFormat | QueryFormat;
 type ParseFormatString = Exclude<FormatString, 'screenshot' | 'changeTracking' | 'branding'>;
 interface ParseFormat {
     type: ParseFormatString;
 }
-type ParseFormatOption = ParseFormatString | ParseFormat | JsonFormat | AttributesFormat | QueryFormat;
+type ParseFormatOption = ParseFormatString | ParseFormat | JsonFormat | AttributesFormat | QuestionFormat | HighlightsFormat | QueryFormat;
 interface LocationConfig$1 {
     country?: string;
     languages?: string[];
@@ -345,6 +354,7 @@ interface Document {
     }>;
     actions?: Record<string, unknown>;
     answer?: string;
+    highlights?: string;
     warning?: string;
     changeTracking?: Record<string, unknown>;
     branding?: BrandingProfile;
@@ -484,6 +494,126 @@ interface MapOptions {
     origin?: string;
     location?: LocationConfig$1;
 }
+interface MonitorSchedule {
+    cron: string;
+    timezone?: string;
+}
+interface MonitorEmailNotification {
+    enabled?: boolean;
+    recipients?: string[];
+    includeDiffs?: boolean;
+}
+interface MonitorNotification {
+    email?: MonitorEmailNotification;
+}
+interface MonitorWebhookConfig {
+    url: string;
+    headers?: Record<string, string>;
+    metadata?: Record<string, string>;
+    events?: string[];
+}
+interface MonitorScrapeTarget {
+    id?: string;
+    type: 'scrape';
+    urls: string[];
+    scrapeOptions?: ScrapeOptions;
+}
+interface MonitorCrawlTarget {
+    id?: string;
+    type: 'crawl';
+    url: string;
+    crawlOptions?: CrawlOptions;
+    scrapeOptions?: ScrapeOptions;
+}
+type MonitorTarget = MonitorScrapeTarget | MonitorCrawlTarget;
+interface CreateMonitorRequest {
+    name: string;
+    schedule: MonitorSchedule;
+    webhook?: MonitorWebhookConfig;
+    notification?: MonitorNotification;
+    targets: MonitorTarget[];
+    retentionDays?: number;
+}
+interface UpdateMonitorRequest {
+    name?: string;
+    status?: 'active' | 'paused';
+    schedule?: MonitorSchedule;
+    webhook?: MonitorWebhookConfig | null;
+    notification?: MonitorNotification | null;
+    targets?: MonitorTarget[];
+    retentionDays?: number;
+}
+interface MonitorSummary {
+    totalPages: number;
+    same: number;
+    changed: number;
+    new: number;
+    removed: number;
+    error: number;
+}
+interface Monitor {
+    id: string;
+    name: string;
+    status: 'active' | 'paused' | 'deleted';
+    schedule: MonitorSchedule;
+    nextRunAt?: string | null;
+    lastRunAt?: string | null;
+    currentCheckId?: string | null;
+    targets: MonitorTarget[];
+    webhook?: MonitorWebhookConfig | null;
+    notification?: MonitorNotification | null;
+    retentionDays: number;
+    estimatedCreditsPerMonth?: number | null;
+    lastCheckSummary?: MonitorSummary | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface MonitorCheck {
+    id: string;
+    monitorId: string;
+    status: 'queued' | 'running' | 'completed' | 'failed' | 'partial' | 'skipped_overlap';
+    trigger: 'scheduled' | 'manual';
+    scheduledFor?: string | null;
+    startedAt?: string | null;
+    finishedAt?: string | null;
+    estimatedCredits?: number | null;
+    reservedCredits?: number | null;
+    actualCredits?: number | null;
+    billingStatus: 'not_applicable' | 'reserved' | 'confirmed' | 'released' | 'failed';
+    summary: MonitorSummary;
+    targetResults?: unknown;
+    notificationStatus?: unknown;
+    error?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface MonitorCheckPage {
+    id: string;
+    targetId: string;
+    url: string;
+    status: 'same' | 'new' | 'changed' | 'removed' | 'error';
+    previousScrapeId?: string | null;
+    currentScrapeId?: string | null;
+    statusCode?: number | null;
+    error?: string | null;
+    metadata?: unknown;
+    diff?: unknown;
+    createdAt: string;
+}
+interface MonitorCheckDetail extends MonitorCheck {
+    pages: MonitorCheckPage[];
+    next?: string | null;
+}
+interface ListMonitorsOptions {
+    limit?: number;
+    offset?: number;
+}
+type ListMonitorChecksOptions = ListMonitorsOptions;
+type GetMonitorCheckOptions = PaginationConfig & {
+    limit?: number;
+    skip?: number;
+    status?: MonitorCheckPage["status"];
+};
 interface ExtractResponse$1 {
     success?: boolean;
     id?: string;
@@ -671,6 +801,7 @@ declare class HttpClient {
     postMultipart<T = any>(endpoint: string, formData: FormData, options?: RequestOptions): Promise<AxiosResponse<T, any, {}>>;
     get<T = any>(endpoint: string, headers?: Record<string, string>): Promise<AxiosResponse<T, any, {}>>;
     delete<T = any>(endpoint: string, headers?: Record<string, string>): Promise<AxiosResponse<T, any, {}>>;
+    patch<T = any>(endpoint: string, body: Record<string, unknown>, options?: RequestOptions): Promise<AxiosResponse<T, any, {}>>;
     prepareHeaders(idempotencyKey?: string): Record<string, string>;
 }
 
@@ -889,6 +1020,38 @@ declare class FirecrawlClient {
      * @param prompt Natural-language instruction.
      */
     crawlParamsPreview(url: string, prompt: string): Promise<Record<string, unknown>>;
+    /**
+     * Create a scheduled monitor.
+     */
+    createMonitor(request: CreateMonitorRequest): Promise<Monitor>;
+    /**
+     * List monitors for the authenticated team.
+     */
+    listMonitors(options?: ListMonitorsOptions): Promise<Monitor[]>;
+    /**
+     * Get a monitor by id.
+     */
+    getMonitor(monitorId: string): Promise<Monitor>;
+    /**
+     * Update a monitor.
+     */
+    updateMonitor(monitorId: string, request: UpdateMonitorRequest): Promise<Monitor>;
+    /**
+     * Delete a monitor.
+     */
+    deleteMonitor(monitorId: string): Promise<boolean>;
+    /**
+     * Trigger a manual monitor check.
+     */
+    runMonitor(monitorId: string): Promise<MonitorCheck>;
+    /**
+     * List checks for a monitor.
+     */
+    listMonitorChecks(monitorId: string, options?: ListMonitorChecksOptions): Promise<MonitorCheck[]>;
+    /**
+     * Get a monitor check with paginated page results and inline diffs.
+     */
+    getMonitorCheck(monitorId: string, checkId: string, options?: GetMonitorCheckOptions): Promise<MonitorCheckDetail>;
     /**
      * Start a batch scrape job for multiple URLs (async).
      * @param urls URLs to scrape.
@@ -1928,4 +2091,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, JobTimeoutError, type JsonFormat, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type PDFAction, type PaginationConfig, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type PressAction, type QueryFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AgentOptions$1 as AgentOptions, type AgentResponse, type AgentStatusResponse, type AgentWebhookConfig, type AgentWebhookEvent, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, type BrandingProfile, type BrowserCreateResponse, type BrowserDeleteResponse, type BrowserExecuteResponse, type BrowserListResponse, type BrowserSession, type CategoryOption, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, type CrawlOptions, type CrawlResponse$1 as CrawlResponse, type CreateMonitorRequest, type CreditUsage, type CreditUsageHistoricalPeriod, type CreditUsageHistoricalResponse, type Document, type DocumentMetadata, type ErrorDetails, type ExecuteJavascriptAction, type ExtractResponse$1 as ExtractResponse, Firecrawl, FirecrawlApp as FirecrawlAppV1, FirecrawlClient, type FirecrawlClientOptions, type Format, type FormatOption, type FormatString, type GetMonitorCheckOptions, type HighlightsFormat, JobTimeoutError, type JsonFormat, type ListMonitorChecksOptions, type ListMonitorsOptions, type LocationConfig$1 as LocationConfig, type MapData, type MapOptions, type Monitor, type MonitorCheck, type MonitorCheckDetail, type MonitorCheckPage, type MonitorCrawlTarget, type MonitorEmailNotification, type MonitorNotification, type MonitorSchedule, type MonitorScrapeTarget, type MonitorSummary, type MonitorTarget, type MonitorWebhookConfig, type PDFAction, type PaginationConfig, type ParseFile, type ParseFileData, type ParseFormat, type ParseFormatOption, type ParseFormatString, type ParseOptions, type PressAction, type QueryFormat, type QuestionFormat, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, type ScrapeBrowserDeleteResponse, type ScrapeExecuteRequest, type ScrapeExecuteResponse, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type TokenUsage, type TokenUsageHistoricalPeriod, type TokenUsageHistoricalResponse, type UpdateMonitorRequest, type Viewport, type WaitAction, Watcher, type WatcherOptions, type WebhookConfig, type WriteAction, Firecrawl as default };