firecrawl 1.5.2 → 1.5.3

package/dist/index.cjs

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   CrawlWatcher: () => CrawlWatcher,
+  FirecrawlError: () => FirecrawlError,
   default: () => FirecrawlApp
 });
 module.exports = __toCommonJS(src_exports);
@@ -38,6 +39,13 @@ var import_axios = __toESM(require("axios"), 1);
 var import_zod_to_json_schema = require("zod-to-json-schema");
 var import_isows = require("isows");
 var import_typescript_event_target = require("typescript-event-target");
+var FirecrawlError = class extends Error {
+  statusCode;
+  constructor(message, statusCode) {
+    super(message);
+    this.statusCode = statusCode;
+  }
+};
 var FirecrawlApp = class {
   apiKey;
   apiUrl;
@@ -47,7 +55,7 @@ var FirecrawlApp = class {
    */
   constructor({ apiKey = null, apiUrl = null }) {
     if (typeof apiKey !== "string") {
-      throw new Error("No API key provided");
+      throw new FirecrawlError("No API key provided", 401);
     }
     this.apiKey = apiKey;
     this.apiUrl = apiUrl || "https://api.firecrawl.dev";
@@ -94,13 +102,13 @@ var FirecrawlApp = class {
             ...responseData.data
           };
         } else {
-          throw new Error(`Failed to scrape URL. Error: ${responseData.error}`);
+          throw new FirecrawlError(`Failed to scrape URL. Error: ${responseData.error}`, response.status);
         }
       } else {
         this.handleError(response, "scrape URL");
       }
     } catch (error) {
-      throw new Error(error.message);
+      throw new FirecrawlError(error.message, 500);
     }
     return { success: false, error: "Internal server error." };
   }
@@ -111,7 +119,7 @@ var FirecrawlApp = class {
    * @returns Throws an error advising to use version 0 of the API.
    */
   async search(query, params) {
-    throw new Error("Search is not supported in v1, please downgrade Firecrawl to 0.0.36.");
+    throw new FirecrawlError("Search is not supported in v1, please downgrade Firecrawl to 0.0.36.", 400);
   }
   /**
    * Initiates a crawl job for a URL using the Firecrawl API.
@@ -138,9 +146,9 @@ var FirecrawlApp = class {
       }
     } catch (error) {
       if (error.response?.data?.error) {
-        throw new Error(`Request failed with status code ${error.response.status}. Error: ${error.response.data.error} ${error.response.data.details ? ` - ${JSON.stringify(error.response.data.details)}` : ""}`);
+        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 Error(error.message);
+        throw new FirecrawlError(error.message, 500);
       }
     }
     return { success: false, error: "Internal server error." };
@@ -161,9 +169,9 @@ var FirecrawlApp = class {
       }
     } catch (error) {
       if (error.response?.data?.error) {
-        throw new Error(`Request failed with status code ${error.response.status}. Error: ${error.response.data.error} ${error.response.data.details ? ` - ${JSON.stringify(error.response.data.details)}` : ""}`);
+        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 Error(error.message);
+        throw new FirecrawlError(error.message, 500);
       }
     }
     return { success: false, error: "Internal server error." };
@@ -176,7 +184,7 @@ var FirecrawlApp = class {
    */
   async checkCrawlStatus(id, getAllData = false) {
     if (!id) {
-      throw new Error("No crawl ID provided");
+      throw new FirecrawlError("No crawl ID provided", 400);
     }
     const headers = this.prepareHeaders();
     try {
@@ -212,7 +220,7 @@ var FirecrawlApp = class {
         this.handleError(response, "check crawl status");
       }
     } catch (error) {
-      throw new Error(error.message);
+      throw new FirecrawlError(error.message, 500);
     }
     return { success: false, error: "Internal server error." };
   }
@@ -222,7 +230,7 @@ var FirecrawlApp = class {
       const id = crawl.id;
       return new CrawlWatcher(id, this);
     }
-    throw new Error("Crawl job failed to start");
+    throw new FirecrawlError("Crawl job failed to start", 400);
   }
   async mapUrl(url, params) {
     const headers = this.prepareHeaders();
@@ -239,7 +247,7 @@ var FirecrawlApp = class {
         this.handleError(response, "map");
       }
     } catch (error) {
-      throw new Error(error.message);
+      throw new FirecrawlError(error.message, 500);
     }
     return { success: false, error: "Internal server error." };
   }
@@ -309,7 +317,7 @@ var FirecrawlApp = class {
             statusData.data = data;
             return statusData;
           } else {
-            throw new Error("Crawl job completed but no data was returned");
+            throw new FirecrawlError("Crawl job completed but no data was returned", 500);
           }
         } else if (["active", "paused", "pending", "queued", "waiting", "scraping"].includes(statusData.status)) {
           checkInterval = Math.max(checkInterval, 2);
@@ -317,8 +325,9 @@ var FirecrawlApp = class {
             (resolve) => setTimeout(resolve, checkInterval * 1e3)
           );
         } else {
-          throw new Error(
-            `Crawl job failed or was stopped. Status: ${statusData.status}`
+          throw new FirecrawlError(
+            `Crawl job failed or was stopped. Status: ${statusData.status}`,
+            500
           );
         }
       } else {
@@ -334,12 +343,14 @@ var FirecrawlApp = class {
   handleError(response, action) {
     if ([402, 408, 409, 500].includes(response.status)) {
       const errorMessage = response.data.error || "Unknown error occurred";
-      throw new Error(
-        `Failed to ${action}. Status code: ${response.status}. Error: ${errorMessage}`
+      throw new FirecrawlError(
+        `Failed to ${action}. Status code: ${response.status}. Error: ${errorMessage}`,
+        response.status
       );
     } else {
-      throw new Error(
-        `Unexpected error occurred while trying to ${action}. Status code: ${response.status}`
+      throw new FirecrawlError(
+        `Unexpected error occurred while trying to ${action}. Status code: ${response.status}`,
+        response.status
       );
     }
   }
@@ -414,5 +425,6 @@ var CrawlWatcher = class extends import_typescript_event_target.TypedEventTarget
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  CrawlWatcher
+  CrawlWatcher,
+  FirecrawlError
 });

package/dist/index.d.cts

@@ -183,6 +183,14 @@ interface ErrorResponse {
     success: false;
     error: string;
 }
+/**
+ * Custom error class for Firecrawl.
+ * Extends the built-in Error class to include a status code.
+ */
+declare class FirecrawlError extends Error {
+    statusCode: number;
+    constructor(message: string, statusCode: number);
+}
 /**
  * Main class for interacting with the Firecrawl API.
  * Provides methods for scraping, searching, crawling, and mapping web content.
@@ -285,4 +293,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, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };
+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 };

package/dist/index.d.ts

@@ -183,6 +183,14 @@ interface ErrorResponse {
     success: false;
     error: string;
 }
+/**
+ * Custom error class for Firecrawl.
+ * Extends the built-in Error class to include a status code.
+ */
+declare class FirecrawlError extends Error {
+    statusCode: number;
+    constructor(message: string, statusCode: number);
+}
 /**
  * Main class for interacting with the Firecrawl API.
  * Provides methods for scraping, searching, crawling, and mapping web content.
@@ -285,4 +293,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, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };
+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 };

package/dist/index.js

@@ -3,6 +3,13 @@ import axios, { AxiosError } from "axios";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import { WebSocket } from "isows";
 import { TypedEventTarget } from "typescript-event-target";
+var FirecrawlError = class extends Error {
+  statusCode;
+  constructor(message, statusCode) {
+    super(message);
+    this.statusCode = statusCode;
+  }
+};
 var FirecrawlApp = class {
   apiKey;
   apiUrl;
@@ -12,7 +19,7 @@ var FirecrawlApp = class {
    */
   constructor({ apiKey = null, apiUrl = null }) {
     if (typeof apiKey !== "string") {
-      throw new Error("No API key provided");
+      throw new FirecrawlError("No API key provided", 401);
     }
     this.apiKey = apiKey;
     this.apiUrl = apiUrl || "https://api.firecrawl.dev";
@@ -59,13 +66,13 @@ var FirecrawlApp = class {
             ...responseData.data
           };
         } else {
-          throw new Error(`Failed to scrape URL. Error: ${responseData.error}`);
+          throw new FirecrawlError(`Failed to scrape URL. Error: ${responseData.error}`, response.status);
         }
       } else {
         this.handleError(response, "scrape URL");
       }
     } catch (error) {
-      throw new Error(error.message);
+      throw new FirecrawlError(error.message, 500);
     }
     return { success: false, error: "Internal server error." };
   }
@@ -76,7 +83,7 @@ var FirecrawlApp = class {
    * @returns Throws an error advising to use version 0 of the API.
    */
   async search(query, params) {
-    throw new Error("Search is not supported in v1, please downgrade Firecrawl to 0.0.36.");
+    throw new FirecrawlError("Search is not supported in v1, please downgrade Firecrawl to 0.0.36.", 400);
   }
   /**
    * Initiates a crawl job for a URL using the Firecrawl API.
@@ -103,9 +110,9 @@ var FirecrawlApp = class {
       }
     } catch (error) {
       if (error.response?.data?.error) {
-        throw new Error(`Request failed with status code ${error.response.status}. Error: ${error.response.data.error} ${error.response.data.details ? ` - ${JSON.stringify(error.response.data.details)}` : ""}`);
+        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 Error(error.message);
+        throw new FirecrawlError(error.message, 500);
       }
     }
     return { success: false, error: "Internal server error." };
@@ -126,9 +133,9 @@ var FirecrawlApp = class {
       }
     } catch (error) {
       if (error.response?.data?.error) {
-        throw new Error(`Request failed with status code ${error.response.status}. Error: ${error.response.data.error} ${error.response.data.details ? ` - ${JSON.stringify(error.response.data.details)}` : ""}`);
+        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 Error(error.message);
+        throw new FirecrawlError(error.message, 500);
       }
     }
     return { success: false, error: "Internal server error." };
@@ -141,7 +148,7 @@ var FirecrawlApp = class {
    */
   async checkCrawlStatus(id, getAllData = false) {
     if (!id) {
-      throw new Error("No crawl ID provided");
+      throw new FirecrawlError("No crawl ID provided", 400);
     }
     const headers = this.prepareHeaders();
     try {
@@ -177,7 +184,7 @@ var FirecrawlApp = class {
         this.handleError(response, "check crawl status");
       }
     } catch (error) {
-      throw new Error(error.message);
+      throw new FirecrawlError(error.message, 500);
     }
     return { success: false, error: "Internal server error." };
   }
@@ -187,7 +194,7 @@ var FirecrawlApp = class {
       const id = crawl.id;
       return new CrawlWatcher(id, this);
     }
-    throw new Error("Crawl job failed to start");
+    throw new FirecrawlError("Crawl job failed to start", 400);
   }
   async mapUrl(url, params) {
     const headers = this.prepareHeaders();
@@ -204,7 +211,7 @@ var FirecrawlApp = class {
         this.handleError(response, "map");
       }
     } catch (error) {
-      throw new Error(error.message);
+      throw new FirecrawlError(error.message, 500);
     }
     return { success: false, error: "Internal server error." };
   }
@@ -274,7 +281,7 @@ var FirecrawlApp = class {
             statusData.data = data;
             return statusData;
           } else {
-            throw new Error("Crawl job completed but no data was returned");
+            throw new FirecrawlError("Crawl job completed but no data was returned", 500);
           }
         } else if (["active", "paused", "pending", "queued", "waiting", "scraping"].includes(statusData.status)) {
           checkInterval = Math.max(checkInterval, 2);
@@ -282,8 +289,9 @@ var FirecrawlApp = class {
             (resolve) => setTimeout(resolve, checkInterval * 1e3)
           );
         } else {
-          throw new Error(
-            `Crawl job failed or was stopped. Status: ${statusData.status}`
+          throw new FirecrawlError(
+            `Crawl job failed or was stopped. Status: ${statusData.status}`,
+            500
           );
         }
       } else {
@@ -299,12 +307,14 @@ var FirecrawlApp = class {
   handleError(response, action) {
     if ([402, 408, 409, 500].includes(response.status)) {
       const errorMessage = response.data.error || "Unknown error occurred";
-      throw new Error(
-        `Failed to ${action}. Status code: ${response.status}. Error: ${errorMessage}`
+      throw new FirecrawlError(
+        `Failed to ${action}. Status code: ${response.status}. Error: ${errorMessage}`,
+        response.status
       );
     } else {
-      throw new Error(
-        `Unexpected error occurred while trying to ${action}. Status code: ${response.status}`
+      throw new FirecrawlError(
+        `Unexpected error occurred while trying to ${action}. Status code: ${response.status}`,
+        response.status
       );
     }
   }
@@ -379,5 +389,6 @@ var CrawlWatcher = class extends TypedEventTarget {
 };
 export {
   CrawlWatcher,
+  FirecrawlError,
   FirecrawlApp as default
 };

package/package.json

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

package/src/index.ts

@@ -199,6 +199,19 @@ export interface ErrorResponse {
   error: string;
 }
 
+
+/**
+ * Custom error class for Firecrawl.
+ * Extends the built-in Error class to include a status code.
+ */
+export class FirecrawlError extends Error {
+  statusCode: number;
+  constructor(message: string, statusCode: number) {
+    super(message);
+    this.statusCode = statusCode;
+  }
+}
+
 /**
  * Main class for interacting with the Firecrawl API.
  * Provides methods for scraping, searching, crawling, and mapping web content.
@@ -213,7 +226,7 @@ export default class FirecrawlApp {
    */
   constructor({ apiKey = null, apiUrl = null }: FirecrawlAppConfig) {
     if (typeof apiKey !== "string") {
-      throw new Error("No API key provided");
+      throw new FirecrawlError("No API key provided", 401);
     }
 
     this.apiKey = apiKey;
@@ -268,13 +281,13 @@ export default class FirecrawlApp {
             ...responseData.data
           };
         } else {
-          throw new Error(`Failed to scrape URL. Error: ${responseData.error}`);
+          throw new FirecrawlError(`Failed to scrape URL. Error: ${responseData.error}`, response.status);
         }
       } else {
         this.handleError(response, "scrape URL");
       }
     } catch (error: any) {
-      throw new Error(error.message);
+      throw new FirecrawlError(error.message, 500);
     }
     return { success: false, error: "Internal server error." };
   }
@@ -289,7 +302,7 @@ export default class FirecrawlApp {
     query: string,
     params?: any
   ): Promise<any> {
-    throw new Error("Search is not supported in v1, please downgrade Firecrawl to 0.0.36.");
+    throw new FirecrawlError("Search is not supported in v1, please downgrade Firecrawl to 0.0.36.", 400);
   }
 
   /**
@@ -322,9 +335,9 @@ export default class FirecrawlApp {
       }
     } catch (error: any) {
       if (error.response?.data?.error) {
-        throw new Error(`Request failed with status code ${error.response.status}. Error: ${error.response.data.error} ${error.response.data.details ? ` - ${JSON.stringify(error.response.data.details)}` : ''}`);
+        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 Error(error.message);
+        throw new FirecrawlError(error.message, 500);
       }
     }
     return { success: false, error: "Internal server error." };
@@ -350,9 +363,9 @@ export default class FirecrawlApp {
       }
     } catch (error: any) {
       if (error.response?.data?.error) {
-        throw new Error(`Request failed with status code ${error.response.status}. Error: ${error.response.data.error} ${error.response.data.details ? ` - ${JSON.stringify(error.response.data.details)}` : ''}`);
+        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 Error(error.message);
+        throw new FirecrawlError(error.message, 500);
       }
     }
     return { success: false, error: "Internal server error." };
@@ -366,7 +379,7 @@ export default class FirecrawlApp {
    */
   async checkCrawlStatus(id?: string, getAllData = false): Promise<CrawlStatusResponse | ErrorResponse> {
     if (!id) {
-      throw new Error("No crawl ID provided");
+      throw new FirecrawlError("No crawl ID provided", 400);
     }
 
     const headers: AxiosRequestHeaders = this.prepareHeaders();
@@ -403,7 +416,7 @@ export default class FirecrawlApp {
         this.handleError(response, "check crawl status");
       }
     } catch (error: any) {
-      throw new Error(error.message);
+      throw new FirecrawlError(error.message, 500);
     }
     return { success: false, error: "Internal server error." };
   }
@@ -420,7 +433,7 @@ export default class FirecrawlApp {
       return new CrawlWatcher(id, this);
     }
 
-    throw new Error("Crawl job failed to start");
+    throw new FirecrawlError("Crawl job failed to start", 400);
   }
 
   async mapUrl(url: string, params?: MapParams): Promise<MapResponse | ErrorResponse> {
@@ -439,7 +452,7 @@ export default class FirecrawlApp {
         this.handleError(response, "map");
       }
     } catch (error: any) {
-      throw new Error(error.message);
+      throw new FirecrawlError(error.message, 500);
     }
     return { success: false, error: "Internal server error." };
   }
@@ -524,7 +537,7 @@ export default class FirecrawlApp {
               statusData.data = data;
               return statusData;
             } else {
-              throw new Error("Crawl job completed but no data was returned");
+              throw new FirecrawlError("Crawl job completed but no data was returned", 500);
             }
           } else if (
           ["active", "paused", "pending", "queued", "waiting", "scraping"].includes(statusData.status)
@@ -534,8 +547,9 @@ export default class FirecrawlApp {
             setTimeout(resolve, checkInterval * 1000)
           );
         } else {
-          throw new Error(
-            `Crawl job failed or was stopped. Status: ${statusData.status}`
+          throw new FirecrawlError(
+            `Crawl job failed or was stopped. Status: ${statusData.status}`,
+            500
           );
         }
       } else {
@@ -553,12 +567,14 @@ export default class FirecrawlApp {
     if ([402, 408, 409, 500].includes(response.status)) {
       const errorMessage: string =
         response.data.error || "Unknown error occurred";
-      throw new Error(
-        `Failed to ${action}. Status code: ${response.status}. Error: ${errorMessage}`
+      throw new FirecrawlError(
+        `Failed to ${action}. Status code: ${response.status}. Error: ${errorMessage}`,
+        response.status
       );
     } else {
-      throw new Error(
-        `Unexpected error occurred while trying to ${action}. Status code: ${response.status}`
+      throw new FirecrawlError(
+        `Unexpected error occurred while trying to ${action}. Status code: ${response.status}`,
+        response.status
       );
     }
   }