firecrawl 4.1.0 → 4.2.0

package/dist/{chunk-EX7LNARR.js → chunk-MKEZ44MR.js}

@@ -8,7 +8,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.1.0",
+      version: "4.2.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.1.0",
+      version: "4.2.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -756,6 +756,16 @@ async function getTokenUsage(http) {
     throw err;
   }
 }
+async function getQueueStatus(http) {
+  try {
+    const res = await http.get("/v2/team/queue-status");
+    if (res.status !== 200 || !res.data?.success) throwForBadResponse(res, "get queue status");
+    return res.data;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "get queue status");
+    throw err;
+  }
+}
 
 // src/v2/watcher.ts
 var import_events = require("events");
@@ -1063,6 +1073,10 @@ var FirecrawlClient = class {
   async getTokenUsage() {
     return getTokenUsage(this.http);
   }
+  /** Metrics about the team's scrape queue. */
+  async getQueueStatus() {
+    return getQueueStatus(this.http);
+  }
   // Watcher
   /**
    * Create a watcher for a crawl or batch job. Emits: `document`, `snapshot`, `done`, `error`.
@@ -2309,6 +2323,31 @@ var FirecrawlApp = class {
     }
     return { success: false, error: "Internal server error." };
   }
+  /**
+   * Gets metrics about the team's scrape queue.
+   * @returns The current queue status.
+   */
+  async getQueueStatus() {
+    const headers = this.prepareHeaders();
+    try {
+      const response = await this.getRequest(
+        `${this.apiUrl}/v1/team/queue-status`,
+        headers
+      );
+      if (response.status === 200) {
+        return response.data;
+      } else {
+        this.handleError(response, "get queue status");
+      }
+    } catch (error) {
+      if (error.response?.data?.error) {
+        throw new FirecrawlError(`Request failed with status code ${error.response.status}. Error: ${error.response.data.error} ${error.response.data.details ? ` - ${JSON.stringify(error.response.data.details)}` : ""}`, error.response.status);
+      } else {
+        throw new FirecrawlError(error.message, 500);
+      }
+    }
+    return { success: false, error: "Internal server error." };
+  }
 };
 var CrawlWatcher = class extends e {
   ws;

package/dist/index.d.cts

@@ -324,6 +324,14 @@ declare class SdkError extends Error {
     details?: unknown;
     constructor(message: string, status?: number, code?: string, details?: unknown);
 }
+interface QueueStatusResponse$1 {
+    success: boolean;
+    jobsInQueue: number;
+    activeJobsInQueue: number;
+    waitingJobsInQueue: number;
+    maxConcurrency: number;
+    mostRecentSuccess: string | null;
+}
 
 interface HttpClientOptions {
     apiKey: string;
@@ -544,6 +552,8 @@ declare class FirecrawlClient {
     getCreditUsage(): Promise<CreditUsage>;
     /** Recent token usage. */
     getTokenUsage(): Promise<TokenUsage>;
+    /** Metrics about the team's scrape queue. */
+    getQueueStatus(): Promise<QueueStatusResponse$1>;
     /**
      * Create a watcher for a crawl or batch job. Emits: `document`, `snapshot`, `done`, `error`.
      * @param jobId Job id.
@@ -1068,6 +1078,20 @@ interface GenerateLLMsTextStatusResponse {
     error?: string;
     expiresAt: string;
 }
+/**
+ * Response interface for queue status operations.
+ */
+interface QueueStatusResponse {
+    success: boolean;
+    jobsInQueue: number;
+    activeJobsInQueue: number;
+    waitingJobsInQueue: number;
+    maxConcurrency: number;
+    /**
+     * ISO timestamp of the most recent successful scrape in the past 24 hours. Will be null if no successful scrape has occurred in the past 24 hours.
+     */
+    mostRecentSuccess: string | null;
+}
 /**
  * Main class for interacting with the Firecrawl API.
  * Provides methods for scraping, searching, crawling, and mapping web content.
@@ -1251,7 +1275,7 @@ declare class FirecrawlApp {
      * @param {AxiosResponse} response - The response from the API.
      * @param {string} action - The action being performed when the error occurred.
      */
-    handleError(response: AxiosResponse, action: string): void;
+    handleError(response: AxiosResponse, action: string): never;
     /**
      * Initiates a deep research operation on a given query and polls until completion.
      * @param query - The query to research.
@@ -1333,6 +1357,11 @@ declare class FirecrawlApp {
      * @returns The current status and results of the generation operation.
      */
     checkGenerateLLMsTextStatus(id: string): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
+    /**
+     * Gets metrics about the team's scrape queue.
+     * @returns The current queue status.
+     */
+    getQueueStatus(): Promise<QueueStatusResponse | ErrorResponse>;
 }
 interface CrawlWatcherEvents {
     document: CustomEvent<FirecrawlDocument<undefined>>;
@@ -1374,4 +1403,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, 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 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 JsonFormat, type LocationConfig, type MapData, type MapOptions, type PDFAction, type PaginationConfig, type PressAction, type ScrapeAction, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type TokenUsage, type Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, 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 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 JsonFormat, type 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 Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };

package/dist/index.d.ts

@@ -324,6 +324,14 @@ declare class SdkError extends Error {
     details?: unknown;
     constructor(message: string, status?: number, code?: string, details?: unknown);
 }
+interface QueueStatusResponse$1 {
+    success: boolean;
+    jobsInQueue: number;
+    activeJobsInQueue: number;
+    waitingJobsInQueue: number;
+    maxConcurrency: number;
+    mostRecentSuccess: string | null;
+}
 
 interface HttpClientOptions {
     apiKey: string;
@@ -544,6 +552,8 @@ declare class FirecrawlClient {
     getCreditUsage(): Promise<CreditUsage>;
     /** Recent token usage. */
     getTokenUsage(): Promise<TokenUsage>;
+    /** Metrics about the team's scrape queue. */
+    getQueueStatus(): Promise<QueueStatusResponse$1>;
     /**
      * Create a watcher for a crawl or batch job. Emits: `document`, `snapshot`, `done`, `error`.
      * @param jobId Job id.
@@ -1068,6 +1078,20 @@ interface GenerateLLMsTextStatusResponse {
     error?: string;
     expiresAt: string;
 }
+/**
+ * Response interface for queue status operations.
+ */
+interface QueueStatusResponse {
+    success: boolean;
+    jobsInQueue: number;
+    activeJobsInQueue: number;
+    waitingJobsInQueue: number;
+    maxConcurrency: number;
+    /**
+     * ISO timestamp of the most recent successful scrape in the past 24 hours. Will be null if no successful scrape has occurred in the past 24 hours.
+     */
+    mostRecentSuccess: string | null;
+}
 /**
  * Main class for interacting with the Firecrawl API.
  * Provides methods for scraping, searching, crawling, and mapping web content.
@@ -1251,7 +1275,7 @@ declare class FirecrawlApp {
      * @param {AxiosResponse} response - The response from the API.
      * @param {string} action - The action being performed when the error occurred.
      */
-    handleError(response: AxiosResponse, action: string): void;
+    handleError(response: AxiosResponse, action: string): never;
     /**
      * Initiates a deep research operation on a given query and polls until completion.
      * @param query - The query to research.
@@ -1333,6 +1357,11 @@ declare class FirecrawlApp {
      * @returns The current status and results of the generation operation.
      */
     checkGenerateLLMsTextStatus(id: string): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
+    /**
+     * Gets metrics about the team's scrape queue.
+     * @returns The current queue status.
+     */
+    getQueueStatus(): Promise<QueueStatusResponse | ErrorResponse>;
 }
 interface CrawlWatcherEvents {
     document: CustomEvent<FirecrawlDocument<undefined>>;
@@ -1374,4 +1403,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, 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 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 JsonFormat, type LocationConfig, type MapData, type MapOptions, type PDFAction, type PaginationConfig, type PressAction, type ScrapeAction, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResultImages, type SearchResultNews, type SearchResultWeb, type TokenUsage, type Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type AttributesFormat, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, 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 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 JsonFormat, type 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 Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-EX7LNARR.js";
+} from "./chunk-MKEZ44MR.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -640,6 +640,16 @@ async function getTokenUsage(http) {
     throw err;
   }
 }
+async function getQueueStatus(http) {
+  try {
+    const res = await http.get("/v2/team/queue-status");
+    if (res.status !== 200 || !res.data?.success) throwForBadResponse(res, "get queue status");
+    return res.data;
+  } catch (err) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "get queue status");
+    throw err;
+  }
+}
 
 // src/v2/watcher.ts
 import { EventEmitter } from "events";
@@ -947,6 +957,10 @@ var FirecrawlClient = class {
   async getTokenUsage() {
     return getTokenUsage(this.http);
   }
+  /** Metrics about the team's scrape queue. */
+  async getQueueStatus() {
+    return getQueueStatus(this.http);
+  }
   // Watcher
   /**
    * Create a watcher for a crawl or batch job. Emits: `document`, `snapshot`, `done`, `error`.
@@ -992,7 +1006,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-MVCQF4ZJ.js");
+      const packageJson = await import("./package-7YDUGTZ6.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);
@@ -2193,6 +2207,31 @@ var FirecrawlApp = class {
     }
     return { success: false, error: "Internal server error." };
   }
+  /**
+   * Gets metrics about the team's scrape queue.
+   * @returns The current queue status.
+   */
+  async getQueueStatus() {
+    const headers = this.prepareHeaders();
+    try {
+      const response = await this.getRequest(
+        `${this.apiUrl}/v1/team/queue-status`,
+        headers
+      );
+      if (response.status === 200) {
+        return response.data;
+      } else {
+        this.handleError(response, "get queue status");
+      }
+    } catch (error) {
+      if (error.response?.data?.error) {
+        throw new FirecrawlError(`Request failed with status code ${error.response.status}. Error: ${error.response.data.error} ${error.response.data.details ? ` - ${JSON.stringify(error.response.data.details)}` : ""}`, error.response.status);
+      } else {
+        throw new FirecrawlError(error.message, 500);
+      }
+    }
+    return { success: false, error: "Internal server error." };
+  }
 };
 var CrawlWatcher = class extends e {
   ws;

package/dist/{package-MVCQF4ZJ.js → package-7YDUGTZ6.js}

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

package/package.json

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

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

@@ -32,5 +32,13 @@ describe("v2.usage e2e", () => {
     const resp = await client.getTokenUsage();
     expect(typeof resp.remainingTokens).toBe("number");
   }, 60_000);
+
+  test("get_queue_status", async () => {
+    const resp = await client.getQueueStatus();
+    expect(typeof resp.jobsInQueue).toBe("number");
+    expect(typeof resp.activeJobsInQueue).toBe("number");
+    expect(typeof resp.waitingJobsInQueue).toBe("number");
+    expect(typeof resp.maxConcurrency).toBe("number");
+  }, 60_000);
 });
 

package/src/v1/index.ts

@@ -568,6 +568,22 @@ export interface GenerateLLMsTextStatusResponse {
   expiresAt: string;
 }
 
+/**
+ * Response interface for queue status operations.
+ */
+export interface QueueStatusResponse {
+  success: boolean;
+  jobsInQueue: number;
+  activeJobsInQueue: number;
+  waitingJobsInQueue: number;
+  maxConcurrency: number;
+
+  /**
+   * ISO timestamp of the most recent successful scrape in the past 24 hours. Will be null if no successful scrape has occurred in the past 24 hours.
+   */
+  mostRecentSuccess: string | null;
+}
+
 /**
  * Main class for interacting with the Firecrawl API.
  * Provides methods for scraping, searching, crawling, and mapping web content.
@@ -1586,7 +1602,7 @@ export default class FirecrawlApp {
    * @param {AxiosResponse} response - The response from the API.
    * @param {string} action - The action being performed when the error occurred.
    */
-  handleError(response: AxiosResponse, action: string): void {
+  handleError(response: AxiosResponse, action: string): never {
     if (!response) {
       throw new FirecrawlError(
         `No response received while trying to ${action}. This may be a network error or the server is unreachable.`,
@@ -2027,6 +2043,33 @@ export default class FirecrawlApp {
     }
     return { success: false, error: "Internal server error." };
   }
+
+  /**
+   * Gets metrics about the team's scrape queue.
+   * @returns The current queue status.
+   */
+  async getQueueStatus(): Promise<QueueStatusResponse | ErrorResponse> {
+    const headers = this.prepareHeaders();
+    try {
+      const response: AxiosResponse = await this.getRequest(
+      `${this.apiUrl}/v1/team/queue-status`,
+        headers
+      );
+
+      if (response.status === 200) {
+        return response.data;
+      } else {
+        this.handleError(response, "get queue status");
+      }
+    } catch (error: any) {
+      if (error.response?.data?.error) {
+        throw new FirecrawlError(`Request failed with status code ${error.response.status}. Error: ${error.response.data.error} ${error.response.data.details ? ` - ${JSON.stringify(error.response.data.details)}` : ''}`, error.response.status);
+      } else {
+        throw new FirecrawlError(error.message, 500);
+      }
+    }
+    return { success: false, error: "Internal server error." };
+  }
 }
 
 interface CrawlWatcherEvents {

package/src/v2/client.ts

@@ -19,7 +19,7 @@ import {
   batchScrape as batchWaiter,
 } from "./methods/batch";
 import { startExtract, getExtractStatus, extract as extractWaiter } from "./methods/extract";
-import { getConcurrency, getCreditUsage, getTokenUsage } from "./methods/usage";
+import { getConcurrency, getCreditUsage, getQueueStatus, getTokenUsage } from "./methods/usage";
 import type {
   Document,
   ScrapeOptions,
@@ -269,6 +269,11 @@ export class FirecrawlClient {
     return getTokenUsage(this.http);
   }
 
+  /** Metrics about the team's scrape queue. */
+  async getQueueStatus() {
+    return getQueueStatus(this.http);
+  }
+
   // Watcher
   /**
    * Create a watcher for a crawl or batch job. Emits: `document`, `snapshot`, `done`, `error`.

package/src/v2/methods/usage.ts

@@ -1,4 +1,4 @@
-import type { ConcurrencyCheck, CreditUsage, TokenUsage } from "../types";
+import type { ConcurrencyCheck, CreditUsage, QueueStatusResponse, TokenUsage } from "../types";
 import { HttpClient } from "../utils/httpClient";
 import { normalizeAxiosError, throwForBadResponse } from "../utils/errorHandler";
 
@@ -37,3 +37,13 @@ export async function getTokenUsage(http: HttpClient): Promise<TokenUsage> {
   }
 }
 
+export async function getQueueStatus(http: HttpClient): Promise<QueueStatusResponse> {
+  try {
+    const res = await http.get<QueueStatusResponse>("/v2/team/queue-status");
+    if (res.status !== 200 || !res.data?.success) throwForBadResponse(res, "get queue status");
+    return res.data;
+  } catch (err: any) {
+    if (err?.isAxiosError) return normalizeAxiosError(err, "get queue status");
+    throw err;
+  }
+}

package/src/v2/types.ts

@@ -388,3 +388,11 @@ export class SdkError extends Error {
   }
 }
 
+export interface QueueStatusResponse {
+  success: boolean;
+  jobsInQueue: number;
+  activeJobsInQueue: number;
+  waitingJobsInQueue: number;
+  maxConcurrency: number;
+  mostRecentSuccess: string | null;
+}