firecrawl 1.7.0 → 1.7.1

package/dist/index.d.cts

@@ -142,6 +142,16 @@ interface CrawlResponse {
     success: true;
     error?: string;
 }
+/**
+ * Response interface for batch scrape operations.
+ * Defines the structure of the response received after initiating a crawl.
+ */
+interface BatchScrapeResponse {
+    id?: string;
+    url?: string;
+    success: true;
+    error?: string;
+}
 /**
  * Response interface for job status checks.
  * Provides detailed status of a crawl job including progress and results.
@@ -156,6 +166,20 @@ interface CrawlStatusResponse {
     next?: string;
     data: FirecrawlDocument<undefined>[];
 }
+/**
+ * Response interface for batch scrape job status checks.
+ * Provides detailed status of a batch scrape job including progress and results.
+ */
+interface BatchScrapeStatusResponse {
+    success: true;
+    status: "scraping" | "completed" | "failed" | "cancelled";
+    completed: number;
+    total: number;
+    creditsUsed: number;
+    expiresAt: Date;
+    next?: string;
+    data: FirecrawlDocument<undefined>[];
+}
 /**
  * Parameters for mapping operations.
  * Defines options for mapping URLs during a crawl.
@@ -263,8 +287,8 @@ declare class FirecrawlApp {
      * @param idempotencyKey - Optional idempotency key for the request.
      * @returns The response from the crawl operation.
      */
-    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string): Promise<CrawlStatusResponse | ErrorResponse>;
-    asyncBatchScrapeUrls(urls: string[], params?: ScrapeParams, idempotencyKey?: string): Promise<CrawlResponse | ErrorResponse>;
+    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    asyncBatchScrapeUrls(urls: string[], params?: ScrapeParams, idempotencyKey?: string): Promise<BatchScrapeResponse | ErrorResponse>;
     /**
      * Initiates a batch scrape job and returns a CrawlWatcher to monitor the job via WebSocket.
      * @param urls - The URL to scrape.
@@ -279,7 +303,7 @@ declare class FirecrawlApp {
      * @param getAllData - Paginate through all the pages of documents, returning the full list of all documents. (default: `false`)
      * @returns The response containing the job status.
      */
-    checkBatchScrapeStatus(id?: string, getAllData?: boolean): Promise<CrawlStatusResponse | ErrorResponse>;
+    checkBatchScrapeStatus(id?: string, getAllData?: boolean): Promise<BatchScrapeStatusResponse | ErrorResponse>;
     /**
      * Prepares the headers for an API request.
      * @param idempotencyKey - Optional key to ensure idempotency.
@@ -344,4 +368,4 @@ declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
     close(): void;
 }
 
-export { type Action, type ActionsResult, type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, FirecrawlError, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };
+export { type Action, type ActionsResult, type BatchScrapeResponse, type BatchScrapeStatusResponse, type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, FirecrawlError, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };

package/dist/index.d.ts

@@ -142,6 +142,16 @@ interface CrawlResponse {
     success: true;
     error?: string;
 }
+/**
+ * Response interface for batch scrape operations.
+ * Defines the structure of the response received after initiating a crawl.
+ */
+interface BatchScrapeResponse {
+    id?: string;
+    url?: string;
+    success: true;
+    error?: string;
+}
 /**
  * Response interface for job status checks.
  * Provides detailed status of a crawl job including progress and results.
@@ -156,6 +166,20 @@ interface CrawlStatusResponse {
     next?: string;
     data: FirecrawlDocument<undefined>[];
 }
+/**
+ * Response interface for batch scrape job status checks.
+ * Provides detailed status of a batch scrape job including progress and results.
+ */
+interface BatchScrapeStatusResponse {
+    success: true;
+    status: "scraping" | "completed" | "failed" | "cancelled";
+    completed: number;
+    total: number;
+    creditsUsed: number;
+    expiresAt: Date;
+    next?: string;
+    data: FirecrawlDocument<undefined>[];
+}
 /**
  * Parameters for mapping operations.
  * Defines options for mapping URLs during a crawl.
@@ -263,8 +287,8 @@ declare class FirecrawlApp {
      * @param idempotencyKey - Optional idempotency key for the request.
      * @returns The response from the crawl operation.
      */
-    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string): Promise<CrawlStatusResponse | ErrorResponse>;
-    asyncBatchScrapeUrls(urls: string[], params?: ScrapeParams, idempotencyKey?: string): Promise<CrawlResponse | ErrorResponse>;
+    batchScrapeUrls(urls: string[], params?: ScrapeParams, pollInterval?: number, idempotencyKey?: string): Promise<BatchScrapeStatusResponse | ErrorResponse>;
+    asyncBatchScrapeUrls(urls: string[], params?: ScrapeParams, idempotencyKey?: string): Promise<BatchScrapeResponse | ErrorResponse>;
     /**
      * Initiates a batch scrape job and returns a CrawlWatcher to monitor the job via WebSocket.
      * @param urls - The URL to scrape.
@@ -279,7 +303,7 @@ declare class FirecrawlApp {
      * @param getAllData - Paginate through all the pages of documents, returning the full list of all documents. (default: `false`)
      * @returns The response containing the job status.
      */
-    checkBatchScrapeStatus(id?: string, getAllData?: boolean): Promise<CrawlStatusResponse | ErrorResponse>;
+    checkBatchScrapeStatus(id?: string, getAllData?: boolean): Promise<BatchScrapeStatusResponse | ErrorResponse>;
     /**
      * Prepares the headers for an API request.
      * @param idempotencyKey - Optional key to ensure idempotency.
@@ -344,4 +368,4 @@ declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
     close(): void;
 }
 
-export { type Action, type ActionsResult, type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, FirecrawlError, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };
+export { type Action, type ActionsResult, type BatchScrapeResponse, type BatchScrapeStatusResponse, type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, FirecrawlError, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };

package/package.json

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

package/src/index.ts

@@ -154,6 +154,17 @@ export interface CrawlResponse {
   error?: string;
 }
 
+/**
+ * Response interface for batch scrape operations.
+ * Defines the structure of the response received after initiating a crawl.
+ */
+export interface BatchScrapeResponse {
+  id?: string;
+  url?: string;
+  success: true;
+  error?: string;
+}
+
 /**
  * Response interface for job status checks.
  * Provides detailed status of a crawl job including progress and results.
@@ -169,6 +180,21 @@ export interface CrawlStatusResponse {
   data: FirecrawlDocument<undefined>[];
 };
 
+/**
+ * Response interface for batch scrape job status checks.
+ * Provides detailed status of a batch scrape job including progress and results.
+ */
+export interface BatchScrapeStatusResponse {
+  success: true;
+  status: "scraping" | "completed" | "failed" | "cancelled";
+  completed: number;
+  total: number;
+  creditsUsed: number;
+  expiresAt: Date;
+  next?: string;
+  data: FirecrawlDocument<undefined>[];
+};
+
 /**
  * Parameters for mapping operations.
  * Defines options for mapping URLs during a crawl.
@@ -506,7 +532,7 @@ export default class FirecrawlApp {
     params?: ScrapeParams,
     pollInterval: number = 2,
     idempotencyKey?: string
-  ): Promise<CrawlStatusResponse | ErrorResponse> {
+  ): Promise<BatchScrapeStatusResponse | ErrorResponse> {
     const headers = this.prepareHeaders(idempotencyKey);
     let jsonData: any = { urls, ...(params ?? {}) };
     try {
@@ -535,7 +561,7 @@ export default class FirecrawlApp {
     urls: string[],
     params?: ScrapeParams,
     idempotencyKey?: string
-  ): Promise<CrawlResponse | ErrorResponse> {
+  ): Promise<BatchScrapeResponse | ErrorResponse> {
     const headers = this.prepareHeaders(idempotencyKey);
     let jsonData: any = { urls, ...(params ?? {}) };
     try {
@@ -587,7 +613,7 @@ export default class FirecrawlApp {
    * @param getAllData - Paginate through all the pages of documents, returning the full list of all documents. (default: `false`)
    * @returns The response containing the job status.
    */
-  async checkBatchScrapeStatus(id?: string, getAllData = false): Promise<CrawlStatusResponse | ErrorResponse> {
+  async checkBatchScrapeStatus(id?: string, getAllData = false): Promise<BatchScrapeStatusResponse | ErrorResponse> {
     if (!id) {
       throw new FirecrawlError("No batch scrape ID provided", 400);
     }