@mendable/firecrawl 4.3.8 → 4.4.1

package/dist/{chunk-I2FDKS37.js → chunk-J3BEBX3Y.js}

@@ -8,7 +8,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.3.8",
+      version: "4.4.1",
       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.3.8",
+      version: "4.4.1",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -953,6 +953,9 @@ var Watcher = class extends import_events.EventEmitter {
 var zt = require("zod");
 var FirecrawlClient = class {
   http;
+  isCloudService(url) {
+    return url.includes("api.firecrawl.dev");
+  }
   /**
    * Create a v2 client.
    * @param options Transport configuration (API key, base URL, timeouts, retries).
@@ -960,8 +963,8 @@ var FirecrawlClient = class {
   constructor(options = {}) {
     const apiKey = options.apiKey ?? process.env.FIRECRAWL_API_KEY ?? "";
     const apiUrl = (options.apiUrl ?? process.env.FIRECRAWL_API_URL ?? "https://api.firecrawl.dev").replace(/\/$/, "");
-    if (!apiKey) {
-      throw new Error("API key is required. Set FIRECRAWL_API_KEY env or pass apiKey.");
+    if (this.isCloudService(apiUrl) && !apiKey) {
+      throw new Error("API key is required for the cloud API. Set FIRECRAWL_API_KEY env or pass apiKey.");
     }
     this.http = new HttpClient({
       apiKey,

package/dist/index.d.cts

@@ -223,14 +223,14 @@ interface SearchData {
     images?: Array<SearchResultImages | Document>;
 }
 interface CategoryOption {
-    type: 'github' | 'research';
+    type: 'github' | 'research' | 'pdf';
 }
 interface SearchRequest {
     query: string;
     sources?: Array<'web' | 'news' | 'images' | {
         type: 'web' | 'news' | 'images';
     }>;
-    categories?: Array<'github' | 'research' | CategoryOption>;
+    categories?: Array<'github' | 'research' | 'pdf' | CategoryOption>;
     limit?: number;
     tbs?: string;
     location?: string;
@@ -486,6 +486,7 @@ interface FirecrawlClientOptions {
  */
 declare class FirecrawlClient {
     private readonly http;
+    private isCloudService;
     /**
      * Create a v2 client.
      * @param options Transport configuration (API key, base URL, timeouts, retries).

package/dist/index.d.ts

@@ -223,14 +223,14 @@ interface SearchData {
     images?: Array<SearchResultImages | Document>;
 }
 interface CategoryOption {
-    type: 'github' | 'research';
+    type: 'github' | 'research' | 'pdf';
 }
 interface SearchRequest {
     query: string;
     sources?: Array<'web' | 'news' | 'images' | {
         type: 'web' | 'news' | 'images';
     }>;
-    categories?: Array<'github' | 'research' | CategoryOption>;
+    categories?: Array<'github' | 'research' | 'pdf' | CategoryOption>;
     limit?: number;
     tbs?: string;
     location?: string;
@@ -486,6 +486,7 @@ interface FirecrawlClientOptions {
  */
 declare class FirecrawlClient {
     private readonly http;
+    private isCloudService;
     /**
      * Create a v2 client.
      * @param options Transport configuration (API key, base URL, timeouts, retries).

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-I2FDKS37.js";
+} from "./chunk-J3BEBX3Y.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -837,6 +837,9 @@ var Watcher = class extends EventEmitter {
 import "zod";
 var FirecrawlClient = class {
   http;
+  isCloudService(url) {
+    return url.includes("api.firecrawl.dev");
+  }
   /**
    * Create a v2 client.
    * @param options Transport configuration (API key, base URL, timeouts, retries).
@@ -844,8 +847,8 @@ var FirecrawlClient = class {
   constructor(options = {}) {
     const apiKey = options.apiKey ?? process.env.FIRECRAWL_API_KEY ?? "";
     const apiUrl = (options.apiUrl ?? process.env.FIRECRAWL_API_URL ?? "https://api.firecrawl.dev").replace(/\/$/, "");
-    if (!apiKey) {
-      throw new Error("API key is required. Set FIRECRAWL_API_KEY env or pass apiKey.");
+    if (this.isCloudService(apiUrl) && !apiKey) {
+      throw new Error("API key is required for the cloud API. Set FIRECRAWL_API_KEY env or pass apiKey.");
     }
     this.http = new HttpClient({
       apiKey,
@@ -1068,7 +1071,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-O3Y6ICGR.js");
+      const packageJson = await import("./package-SYKCM5JT.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);

package/dist/{package-O3Y6ICGR.js → package-SYKCM5JT.js}

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

package/package.json

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

package/src/__tests__/e2e/v1/index.test.ts

@@ -36,7 +36,7 @@ describe('FirecrawlApp E2E Tests', () => {
   test.concurrent('should throw error for blocklisted URL on scrape', async () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
     const blocklistedUrl = "https://facebook.com/fake-test";
-    await expect(app.scrapeUrl(blocklistedUrl)).rejects.toThrow("This website is no longer supported");
+    await expect(app.scrapeUrl(blocklistedUrl)).rejects.toThrow("This website is not currently supported");
   });
 
   test.concurrent('should return successful response for valid scrape', async () => {
@@ -52,13 +52,13 @@ describe('FirecrawlApp E2E Tests', () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
     const response = await app.scrapeUrl(
       'https://roastmywebsite.ai', {
-        formats: ['markdown', 'html', 'rawHtml', 'screenshot', 'links'],
-        headers: { "x-key": "test" },
-        includeTags: ['h1'],
-        excludeTags: ['h2'],
-        onlyMainContent: true,
-        timeout: 30000,
-        waitFor: 1000
+      formats: ['markdown', 'html', 'rawHtml', 'screenshot', 'links'],
+      headers: { "x-key": "test" },
+      includeTags: ['h1'],
+      excludeTags: ['h2'],
+      onlyMainContent: true,
+      timeout: 30000,
+      waitFor: 1000
     });
 
     if (!response.success) {
@@ -70,7 +70,7 @@ describe('FirecrawlApp E2E Tests', () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
     const response = await app.scrapeUrl(
       'https://roastmywebsite.ai', {
-        formats: ['screenshot@fullPage'],
+      formats: ['screenshot@fullPage'],
     });
     if (!response.success) {
       throw new Error(response.error);
@@ -149,7 +149,7 @@ describe('FirecrawlApp E2E Tests', () => {
     }
   }, 60000); // 60 seconds timeout
 
-  test.concurrent('should return successful response for crawl with options and wait for completion', async () => {    
+  test.concurrent('should return successful response for crawl with options and wait for completion', async () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
     const response = await app.crawlUrl('https://roastmywebsite.ai', {
       excludePaths: ['blog/*'],
@@ -192,7 +192,7 @@ describe('FirecrawlApp E2E Tests', () => {
 
   test.concurrent('should check crawl status', async () => {
     const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });
-    const response = await app.asyncCrawlUrl('https://firecrawl.dev', { limit: 20, scrapeOptions: { formats: ['markdown', 'html', 'rawHtml', 'screenshot', 'links']}} as CrawlParams) as CrawlResponse;
+    const response = await app.asyncCrawlUrl('https://firecrawl.dev', { limit: 20, scrapeOptions: { formats: ['markdown', 'html', 'rawHtml', 'screenshot', 'links'] } } as CrawlParams) as CrawlResponse;
     expect(response).not.toBeNull();
     expect(response.id).toBeDefined();
 
@@ -250,16 +250,16 @@ describe('FirecrawlApp E2E Tests', () => {
   });
 
   test.concurrent('should return successful response for valid map', async () => {
-    const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL });    const response = await app.mapUrl('https://roastmywebsite.ai') as MapResponse;
+    const app = new FirecrawlApp({ apiKey: TEST_API_KEY, apiUrl: API_URL }); const response = await app.mapUrl('https://roastmywebsite.ai') as MapResponse;
     expect(response).not.toBeNull();
-    
+
     expect(response.links?.length).toBeGreaterThan(0);
     expect(response.links?.[0]).toContain("https://");
     const filteredLinks = response.links?.filter((link: string) => link.includes("roastmywebsite.ai"));
     expect(filteredLinks?.length).toBeGreaterThan(0);
   }, 30000); // 30 seconds timeout
 
-  
+
 
   test('should search with string query', async () => {
     const app = new FirecrawlApp({ apiUrl: API_URL, apiKey: TEST_API_KEY });

package/src/v2/client.ts

@@ -72,9 +72,14 @@ export interface FirecrawlClientOptions {
 /**
  * Firecrawl v2 client. Provides typed access to all v2 endpoints and utilities.
  */
+
 export class FirecrawlClient {
   private readonly http: HttpClient;
 
+  private isCloudService(url: string): boolean {
+    return url.includes('api.firecrawl.dev');
+  }
+
   /**
    * Create a v2 client.
    * @param options Transport configuration (API key, base URL, timeouts, retries).
@@ -82,9 +87,11 @@ export class FirecrawlClient {
   constructor(options: FirecrawlClientOptions = {}) {
     const apiKey = options.apiKey ?? process.env.FIRECRAWL_API_KEY ?? "";
     const apiUrl = (options.apiUrl ?? process.env.FIRECRAWL_API_URL ?? "https://api.firecrawl.dev").replace(/\/$/, "");
-    if (!apiKey) {
-      throw new Error("API key is required. Set FIRECRAWL_API_KEY env or pass apiKey.");
+
+    if (this.isCloudService(apiUrl) && !apiKey) {
+      throw new Error("API key is required for the cloud API. Set FIRECRAWL_API_KEY env or pass apiKey.");
     }
+
     this.http = new HttpClient({
       apiKey,
       apiUrl,

package/src/v2/types.ts

@@ -286,7 +286,7 @@ export interface SearchData {
 }
 
 export interface CategoryOption {
-  type: 'github' | 'research';
+  type: 'github' | 'research' | 'pdf';
 }
 
 export interface SearchRequest {
@@ -294,7 +294,7 @@ export interface SearchRequest {
   sources?: Array<
     'web' | 'news' | 'images' | { type: 'web' | 'news' | 'images' }
   >;
-  categories?: Array<'github' | 'research' | CategoryOption>;
+  categories?: Array<'github' | 'research' | 'pdf' | CategoryOption>;
   limit?: number;
   tbs?: string;
   location?: string;