firecrawl 1.5.3 → 1.6.0

package/dist/index.cjs

@@ -108,7 +108,7 @@ var FirecrawlApp = class {
         this.handleError(response, "scrape URL");
       }
     } catch (error) {
-      throw new FirecrawlError(error.message, 500);
+      this.handleError(error.response, "scrape URL");
     }
     return { success: false, error: "Internal server error." };
   }
@@ -224,6 +224,35 @@ var FirecrawlApp = class {
     }
     return { success: false, error: "Internal server error." };
   }
+  /**
+   * Cancels a crawl job using the Firecrawl API.
+   * @param id - The ID of the crawl operation.
+   * @returns The response from the cancel crawl operation.
+   */
+  async cancelCrawl(id) {
+    const headers = this.prepareHeaders();
+    try {
+      const response = await this.deleteRequest(
+        `${this.apiUrl}/v1/crawl/${id}`,
+        headers
+      );
+      if (response.status === 200) {
+        return response.data;
+      } else {
+        this.handleError(response, "cancel crawl job");
+      }
+    } catch (error) {
+      throw new FirecrawlError(error.message, 500);
+    }
+    return { success: false, error: "Internal server error." };
+  }
+  /**
+   * Initiates a crawl job and returns a CrawlWatcher to monitor the job via WebSocket.
+   * @param url - The URL to crawl.
+   * @param params - Additional parameters for the crawl request.
+   * @param idempotencyKey - Optional idempotency key for the request.
+   * @returns A CrawlWatcher instance to monitor the crawl job.
+   */
   async crawlUrlAndWatch(url, params, idempotencyKey) {
     const crawl = await this.asyncCrawlUrl(url, params, idempotencyKey);
     if (crawl.success && crawl.id) {
@@ -232,6 +261,12 @@ var FirecrawlApp = class {
     }
     throw new FirecrawlError("Crawl job failed to start", 400);
   }
+  /**
+   * Maps a URL using the Firecrawl API.
+   * @param url - The URL to map.
+   * @param params - Additional parameters for the map request.
+   * @returns The response from the map operation.
+   */
   async mapUrl(url, params) {
     const headers = this.prepareHeaders();
     let jsonData = { url, ...params };
@@ -290,6 +325,23 @@ var FirecrawlApp = class {
       }
     }
   }
+  /**
+   * Sends a DELETE request to the specified URL.
+   * @param url - The URL to send the request to.
+   * @param headers - The headers for the request.
+   * @returns The response from the DELETE request.
+   */
+  async deleteRequest(url, headers) {
+    try {
+      return await import_axios.default.delete(url, { headers });
+    } catch (error) {
+      if (error instanceof import_axios.AxiosError && error.response) {
+        return error.response;
+      } else {
+        throw error;
+      }
+    }
+  }
   /**
    * Monitors the status of a crawl job until completion or failure.
    * @param id - The ID of the crawl operation.

package/dist/index.d.cts

@@ -234,7 +234,26 @@ declare class FirecrawlApp {
      * @returns The response containing the job status.
      */
     checkCrawlStatus(id?: string, getAllData?: boolean): Promise<CrawlStatusResponse | ErrorResponse>;
+    /**
+     * Cancels a crawl job using the Firecrawl API.
+     * @param id - The ID of the crawl operation.
+     * @returns The response from the cancel crawl operation.
+     */
+    cancelCrawl(id: string): Promise<ErrorResponse>;
+    /**
+     * Initiates a crawl job and returns a CrawlWatcher to monitor the job via WebSocket.
+     * @param url - The URL to crawl.
+     * @param params - Additional parameters for the crawl request.
+     * @param idempotencyKey - Optional idempotency key for the request.
+     * @returns A CrawlWatcher instance to monitor the crawl job.
+     */
     crawlUrlAndWatch(url: string, params?: CrawlParams, idempotencyKey?: string): Promise<CrawlWatcher>;
+    /**
+     * Maps a URL using the Firecrawl API.
+     * @param url - The URL to map.
+     * @param params - Additional parameters for the map request.
+     * @returns The response from the map operation.
+     */
     mapUrl(url: string, params?: MapParams): Promise<MapResponse | ErrorResponse>;
     /**
      * Prepares the headers for an API request.
@@ -257,6 +276,13 @@ declare class FirecrawlApp {
      * @returns The response from the GET request.
      */
     getRequest(url: string, headers: AxiosRequestHeaders): Promise<AxiosResponse>;
+    /**
+     * Sends a DELETE request to the specified URL.
+     * @param url - The URL to send the request to.
+     * @param headers - The headers for the request.
+     * @returns The response from the DELETE request.
+     */
+    deleteRequest(url: string, headers: AxiosRequestHeaders): Promise<AxiosResponse>;
     /**
      * Monitors the status of a crawl job until completion or failure.
      * @param id - The ID of the crawl operation.

package/dist/index.d.ts

@@ -234,7 +234,26 @@ declare class FirecrawlApp {
      * @returns The response containing the job status.
      */
     checkCrawlStatus(id?: string, getAllData?: boolean): Promise<CrawlStatusResponse | ErrorResponse>;
+    /**
+     * Cancels a crawl job using the Firecrawl API.
+     * @param id - The ID of the crawl operation.
+     * @returns The response from the cancel crawl operation.
+     */
+    cancelCrawl(id: string): Promise<ErrorResponse>;
+    /**
+     * Initiates a crawl job and returns a CrawlWatcher to monitor the job via WebSocket.
+     * @param url - The URL to crawl.
+     * @param params - Additional parameters for the crawl request.
+     * @param idempotencyKey - Optional idempotency key for the request.
+     * @returns A CrawlWatcher instance to monitor the crawl job.
+     */
     crawlUrlAndWatch(url: string, params?: CrawlParams, idempotencyKey?: string): Promise<CrawlWatcher>;
+    /**
+     * Maps a URL using the Firecrawl API.
+     * @param url - The URL to map.
+     * @param params - Additional parameters for the map request.
+     * @returns The response from the map operation.
+     */
     mapUrl(url: string, params?: MapParams): Promise<MapResponse | ErrorResponse>;
     /**
      * Prepares the headers for an API request.
@@ -257,6 +276,13 @@ declare class FirecrawlApp {
      * @returns The response from the GET request.
      */
     getRequest(url: string, headers: AxiosRequestHeaders): Promise<AxiosResponse>;
+    /**
+     * Sends a DELETE request to the specified URL.
+     * @param url - The URL to send the request to.
+     * @param headers - The headers for the request.
+     * @returns The response from the DELETE request.
+     */
+    deleteRequest(url: string, headers: AxiosRequestHeaders): Promise<AxiosResponse>;
     /**
      * Monitors the status of a crawl job until completion or failure.
      * @param id - The ID of the crawl operation.

package/dist/index.js

@@ -72,7 +72,7 @@ var FirecrawlApp = class {
         this.handleError(response, "scrape URL");
       }
     } catch (error) {
-      throw new FirecrawlError(error.message, 500);
+      this.handleError(error.response, "scrape URL");
     }
     return { success: false, error: "Internal server error." };
   }
@@ -188,6 +188,35 @@ var FirecrawlApp = class {
     }
     return { success: false, error: "Internal server error." };
   }
+  /**
+   * Cancels a crawl job using the Firecrawl API.
+   * @param id - The ID of the crawl operation.
+   * @returns The response from the cancel crawl operation.
+   */
+  async cancelCrawl(id) {
+    const headers = this.prepareHeaders();
+    try {
+      const response = await this.deleteRequest(
+        `${this.apiUrl}/v1/crawl/${id}`,
+        headers
+      );
+      if (response.status === 200) {
+        return response.data;
+      } else {
+        this.handleError(response, "cancel crawl job");
+      }
+    } catch (error) {
+      throw new FirecrawlError(error.message, 500);
+    }
+    return { success: false, error: "Internal server error." };
+  }
+  /**
+   * Initiates a crawl job and returns a CrawlWatcher to monitor the job via WebSocket.
+   * @param url - The URL to crawl.
+   * @param params - Additional parameters for the crawl request.
+   * @param idempotencyKey - Optional idempotency key for the request.
+   * @returns A CrawlWatcher instance to monitor the crawl job.
+   */
   async crawlUrlAndWatch(url, params, idempotencyKey) {
     const crawl = await this.asyncCrawlUrl(url, params, idempotencyKey);
     if (crawl.success && crawl.id) {
@@ -196,6 +225,12 @@ var FirecrawlApp = class {
     }
     throw new FirecrawlError("Crawl job failed to start", 400);
   }
+  /**
+   * Maps a URL using the Firecrawl API.
+   * @param url - The URL to map.
+   * @param params - Additional parameters for the map request.
+   * @returns The response from the map operation.
+   */
   async mapUrl(url, params) {
     const headers = this.prepareHeaders();
     let jsonData = { url, ...params };
@@ -254,6 +289,23 @@ var FirecrawlApp = class {
       }
     }
   }
+  /**
+   * Sends a DELETE request to the specified URL.
+   * @param url - The URL to send the request to.
+   * @param headers - The headers for the request.
+   * @returns The response from the DELETE request.
+   */
+  async deleteRequest(url, headers) {
+    try {
+      return await axios.delete(url, { headers });
+    } catch (error) {
+      if (error instanceof AxiosError && error.response) {
+        return error.response;
+      } else {
+        throw error;
+      }
+    }
+  }
   /**
    * Monitors the status of a crawl job until completion or failure.
    * @param id - The ID of the crawl operation.

package/package.json

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

package/src/index.ts

@@ -287,7 +287,7 @@ export default class FirecrawlApp {
         this.handleError(response, "scrape URL");
       }
     } catch (error: any) {
-      throw new FirecrawlError(error.message, 500);
+      this.handleError(error.response, "scrape URL");
     }
     return { success: false, error: "Internal server error." };
   }
@@ -421,6 +421,36 @@ export default class FirecrawlApp {
     return { success: false, error: "Internal server error." };
   }
 
+  /**
+   * Cancels a crawl job using the Firecrawl API.
+   * @param id - The ID of the crawl operation.
+   * @returns The response from the cancel crawl operation.
+   */
+  async cancelCrawl(id: string): Promise<ErrorResponse> {
+    const headers = this.prepareHeaders();
+    try {
+      const response: AxiosResponse = await this.deleteRequest(
+        `${this.apiUrl}/v1/crawl/${id}`,
+        headers
+      );
+      if (response.status === 200) {
+        return response.data;
+      } else {
+        this.handleError(response, "cancel crawl job");
+      }
+    } catch (error: any) {
+      throw new FirecrawlError(error.message, 500);
+    }
+    return { success: false, error: "Internal server error." };
+  }
+
+  /**
+   * Initiates a crawl job and returns a CrawlWatcher to monitor the job via WebSocket.
+   * @param url - The URL to crawl.
+   * @param params - Additional parameters for the crawl request.
+   * @param idempotencyKey - Optional idempotency key for the request.
+   * @returns A CrawlWatcher instance to monitor the crawl job.
+   */
   async crawlUrlAndWatch(
     url: string,
     params?: CrawlParams,
@@ -436,6 +466,12 @@ export default class FirecrawlApp {
     throw new FirecrawlError("Crawl job failed to start", 400);
   }
 
+  /**
+   * Maps a URL using the Firecrawl API.
+   * @param url - The URL to map.
+   * @param params - Additional parameters for the map request.
+   * @returns The response from the map operation.
+   */
   async mapUrl(url: string, params?: MapParams): Promise<MapResponse | ErrorResponse> {
     const headers = this.prepareHeaders();
     let jsonData: { url: string } & MapParams = { url, ...params };
@@ -506,6 +542,27 @@ export default class FirecrawlApp {
     }
   }
 
+  /**
+   * Sends a DELETE request to the specified URL.
+   * @param url - The URL to send the request to.
+   * @param headers - The headers for the request.
+   * @returns The response from the DELETE request.
+   */
+  async deleteRequest(
+    url: string,
+    headers: AxiosRequestHeaders
+  ): Promise<AxiosResponse> {
+    try {
+        return await axios.delete(url, { headers });
+    } catch (error) {
+      if (error instanceof AxiosError && error.response) {
+        return error.response as AxiosResponse;
+      } else {
+        throw error;
+      }
+    }
+  }
+
   /**
    * Monitors the status of a crawl job until completion or failure.
    * @param id - The ID of the crawl operation.