@mendable/firecrawl 4.11.4 → 4.12.0

package/dist/{chunk-UMVTH3OK.js → chunk-G5AJUV7O.js}

@@ -8,7 +8,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.11.4",
+      version: "4.12.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",

package/dist/index.cjs

@@ -35,7 +35,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.11.4",
+      version: "4.12.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -117,6 +117,7 @@ __export(index_exports, {
   FirecrawlClient: () => FirecrawlClient,
   JobTimeoutError: () => JobTimeoutError,
   SdkError: () => SdkError,
+  Watcher: () => Watcher,
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
@@ -2871,5 +2872,6 @@ var index_default = Firecrawl;
   FirecrawlAppV1,
   FirecrawlClient,
   JobTimeoutError,
-  SdkError
+  SdkError,
+  Watcher
 });

package/dist/index.d.cts

@@ -110,7 +110,7 @@ interface ScrapeOptions {
     fastMode?: boolean;
     useMock?: string;
     blockAds?: boolean;
-    proxy?: 'basic' | 'stealth' | 'auto' | string;
+    proxy?: 'basic' | 'stealth' | 'enhanced' | 'auto' | string;
     maxAge?: number;
     minAge?: number;
     storeInCache?: boolean;
@@ -954,7 +954,7 @@ interface CrawlScrapeOptions {
     skipTlsVerification?: boolean;
     removeBase64Images?: boolean;
     blockAds?: boolean;
-    proxy?: "basic" | "stealth" | "auto";
+    proxy?: "basic" | "stealth" | "enhanced" | "auto";
     storeInCache?: boolean;
     maxAge?: number;
     parsePDF?: boolean;
@@ -1736,4 +1736,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 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 PressAction, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, 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, 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 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 PressAction, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, 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 };

package/dist/index.d.ts

@@ -110,7 +110,7 @@ interface ScrapeOptions {
     fastMode?: boolean;
     useMock?: string;
     blockAds?: boolean;
-    proxy?: 'basic' | 'stealth' | 'auto' | string;
+    proxy?: 'basic' | 'stealth' | 'enhanced' | 'auto' | string;
     maxAge?: number;
     minAge?: number;
     storeInCache?: boolean;
@@ -954,7 +954,7 @@ interface CrawlScrapeOptions {
     skipTlsVerification?: boolean;
     removeBase64Images?: boolean;
     blockAds?: boolean;
-    proxy?: "basic" | "stealth" | "auto";
+    proxy?: "basic" | "stealth" | "enhanced" | "auto";
     storeInCache?: boolean;
     maxAge?: number;
     parsePDF?: boolean;
@@ -1736,4 +1736,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 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 PressAction, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, 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, 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 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 PressAction, type QueueStatusResponse$1 as QueueStatusResponse, type ScrapeAction, 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 };

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-UMVTH3OK.js";
+} from "./chunk-G5AJUV7O.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -1374,7 +1374,7 @@ var FirecrawlApp = class {
       if (typeof process !== "undefined" && process.env && process.env.npm_package_version) {
         return process.env.npm_package_version;
       }
-      const packageJson = await import("./package-4JFABD5Y.js");
+      const packageJson = await import("./package-T35BK7SG.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);
@@ -2752,5 +2752,6 @@ export {
   FirecrawlClient,
   JobTimeoutError,
   SdkError,
+  Watcher,
   index_default as default
 };

package/dist/{package-4JFABD5Y.js → package-T35BK7SG.js}

@@ -1,4 +1,4 @@
 import {
   require_package
-} from "./chunk-UMVTH3OK.js";
+} from "./chunk-G5AJUV7O.js";
 export default require_package();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mendable/firecrawl",
-  "version": "4.11.4",
+  "version": "4.12.0",
   "description": "JavaScript SDK for Firecrawl API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/__tests__/e2e/v2/scrape.test.ts

@@ -128,9 +128,9 @@ describe("v2.scrape e2e", () => {
     });
     expect(doc.images).toBeTruthy();
     expect(Array.isArray(doc.images)).toBe(true);
-    expect(doc.images.length).toBeGreaterThan(0);
+    expect(doc.images?.length).toBeGreaterThan(0);
     // Should find firecrawl logo/branding images
-    expect(doc.images.some(img => img.includes("firecrawl") || img.includes("logo"))).toBe(true);
+    expect(doc.images?.some(img => img.includes("firecrawl") || img.includes("logo"))).toBe(true);
   }, 60_000);
 
   test("images format: works with multiple formats", async () => {
@@ -142,7 +142,7 @@ describe("v2.scrape e2e", () => {
     expect(doc.links).toBeTruthy();
     expect(doc.images).toBeTruthy();
     expect(Array.isArray(doc.images)).toBe(true);
-    expect(doc.images.length).toBeGreaterThan(0);
+    expect(doc.images?.length).toBeGreaterThan(0);
     
     // Images should find things not available in links format
     const imageExtensions = ['.jpg', '.jpeg', '.png', '.gif', '.webp', '.svg', '.ico'];
@@ -151,7 +151,7 @@ describe("v2.scrape e2e", () => {
     ) || [];
     
     // Should discover additional images beyond those with obvious extensions
-    expect(doc.images.length).toBeGreaterThanOrEqual(linkImages.length);
+    expect(doc.images?.length).toBeGreaterThanOrEqual(linkImages.length);
   }, 60_000);
 
   test("invalid url should throw", async () => {

package/src/__tests__/e2e/v2/search.test.ts

@@ -2,7 +2,7 @@
  * E2E tests for v2 search (translated from Python tests)
  */
 import Firecrawl from "../../../index";
-import type { Document, SearchResult } from "../../../index";
+import type { Document, SearchResultWeb, SearchResultNews, SearchResultImages } from "../../../index";
 import { config } from "dotenv";
 import { getIdentity, getApiUrl } from "./utils/idmux";
 import { describe, test, expect, beforeAll } from "@jest/globals";
@@ -28,7 +28,7 @@ function collectTexts(entries: any[] | undefined): string[] {
   return texts;
 }
 
-function isDocument(entry: Document | SearchResult | undefined | null): entry is Document {
+function isDocument(entry: Document | SearchResultWeb | SearchResultNews | SearchResultImages | undefined | null): entry is Document {
   if (!entry) return false;
   const d = entry as Document;
   return (
@@ -86,10 +86,10 @@ describe("v2.search e2e", () => {
     expect(results.images == null).toBe(true);
 
     const webTitles = (results.web || [])
-      .filter((r): r is SearchResult => !isDocument(r))
+      .filter((r): r is SearchResultWeb => !isDocument(r))
       .map(r => (r.title || "").toString().toLowerCase());
     const webDescriptions = (results.web || [])
-      .filter((r): r is SearchResult => !isDocument(r))
+      .filter((r): r is SearchResultWeb => !isDocument(r))
       .map(r => (r.description || "").toString().toLowerCase());
     const allWebText = (webTitles.concat(webDescriptions)).join(" ");
     expect(allWebText.includes("firecrawl")).toBe(true);
@@ -183,7 +183,7 @@ describe("v2.search e2e", () => {
           expect(Boolean(result.markdown) || Boolean(result.html)).toBe(true);
         } else {
           expect(typeof result.url).toBe("string");
-          expect(result.url.startsWith("http")).toBe(true);
+          expect(result.url?.startsWith("http")).toBe(true);
         }
       }
     }
@@ -193,7 +193,7 @@ describe("v2.search e2e", () => {
     for (const result of results.images || []) {
       if (!isDocument(result)) {
         expect(typeof result.url).toBe("string");
-        expect(result.url.startsWith("http")).toBe(true);
+        expect(result.url?.startsWith("http")).toBe(true);
       }
     }
   }, 120_000);

package/src/__tests__/e2e/v2/usage.test.ts

@@ -23,16 +23,15 @@ describe("v2.usage e2e", () => {
     expect(typeof resp.maxConcurrency).toBe("number");
   }, 60_000);
 
-  // NOTE: Disabled, broken on central team due to overflow
-  // test("get_credit_usage", async () => {
-  //   const resp = await client.getCreditUsage();
-  //   expect(typeof resp.remainingCredits).toBe("number");
-  // }, 60_000);
-
-  // test("get_token_usage", async () => {
-  //   const resp = await client.getTokenUsage();
-  //   expect(typeof resp.remainingTokens).toBe("number");
-  // }, 60_000);
+  test("get_credit_usage", async () => {
+    const resp = await client.getCreditUsage();
+    expect(typeof resp.remainingCredits).toBe("number");
+  }, 60_000);
+
+  test("get_token_usage", async () => {
+    const resp = await client.getTokenUsage();
+    expect(typeof resp.remainingTokens).toBe("number");
+  }, 60_000);
 
   test("get_queue_status", async () => {
     const resp = await client.getQueueStatus();

package/src/index.ts

@@ -9,6 +9,8 @@
 export { FirecrawlClient } from "./v2/client";
 /** Public v2 request/response types. */
 export * from "./v2/types";
+/** Watcher class and options for crawl/batch job monitoring. */
+export { Watcher, type WatcherOptions } from "./v2/watcher";
 /** Legacy v1 client (feature‑frozen). */
 export { default as FirecrawlAppV1 } from "./v1";
 

package/src/v1/index.ts

@@ -131,7 +131,7 @@ export interface CrawlScrapeOptions {
   skipTlsVerification?: boolean;
   removeBase64Images?: boolean;
   blockAds?: boolean;
-  proxy?: "basic" | "stealth" | "auto";
+  proxy?: "basic" | "stealth" | "enhanced" | "auto";
   storeInCache?: boolean;
   maxAge?: number;
   parsePDF?: boolean;

package/src/v2/types.ts

@@ -153,7 +153,7 @@ export interface ScrapeOptions {
   fastMode?: boolean;
   useMock?: string;
   blockAds?: boolean;
-  proxy?: 'basic' | 'stealth' | 'auto' | string;
+  proxy?: 'basic' | 'stealth' | 'enhanced' | 'auto' | string;
   maxAge?: number;
   minAge?: number;
   storeInCache?: boolean;