firecrawl 3.0.3 → 3.2.0

package/dist/{chunk-OIZ6OKY4.js → chunk-NVTWBXZM.js}

@@ -7,8 +7,8 @@ var __commonJS = (cb, mod) => function __require() {
 var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
-      name: "@mendable/firecrawl-js",
-      version: "3.0.3",
+      name: "firecrawl",
+      version: "3.2.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",

package/dist/index.cjs

@@ -34,8 +34,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
-      name: "@mendable/firecrawl-js",
-      version: "3.0.3",
+      name: "firecrawl",
+      version: "3.2.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -108,15 +108,15 @@ var require_package = __commonJS({
 });
 
 // src/index.ts
-var index_exports = {};
-__export(index_exports, {
+var src_exports = {};
+__export(src_exports, {
   Firecrawl: () => Firecrawl,
   FirecrawlAppV1: () => FirecrawlApp,
   FirecrawlClient: () => FirecrawlClient,
   SdkError: () => SdkError,
-  default: () => index_default
+  default: () => src_default
 });
-module.exports = __toCommonJS(index_exports);
+module.exports = __toCommonJS(src_exports);
 
 // src/v2/utils/httpClient.ts
 var import_axios = __toESM(require("axios"), 1);
@@ -316,6 +316,7 @@ function prepareSearchPayload(req) {
     query: req.query
   };
   if (req.sources) payload.sources = req.sources;
+  if (req.categories) payload.categories = req.categories;
   if (req.limit != null) payload.limit = req.limit;
   if (req.tbs != null) payload.tbs = req.tbs;
   if (req.location != null) payload.location = req.location;
@@ -327,6 +328,21 @@ function prepareSearchPayload(req) {
   }
   return payload;
 }
+function transformArray(arr) {
+  const results = [];
+  for (const item of arr) {
+    if (item && typeof item === "object") {
+      if ("markdown" in item || "html" in item || "rawHtml" in item || "links" in item || "screenshot" in item || "changeTracking" in item || "summary" in item || "json" in item) {
+        results.push(item);
+      } else {
+        results.push(item);
+      }
+    } else {
+      results.push({ url: item });
+    }
+  }
+  return results;
+}
 async function search(http, request) {
   const payload = prepareSearchPayload(request);
   try {
@@ -336,24 +352,9 @@ async function search(http, request) {
     }
     const data = res.data.data || {};
     const out = {};
-    for (const key of Object.keys(data)) {
-      const arr = data[key];
-      if (Array.isArray(arr)) {
-        const results = [];
-        for (const item of arr) {
-          if (item && typeof item === "object") {
-            if ("markdown" in item || "html" in item || "rawHtml" in item || "links" in item || "screenshot" in item || "changeTracking" in item || "summary" in item || "json" in item) {
-              results.push(item);
-            } else {
-              results.push({ url: item.url, title: item.title, description: item.description });
-            }
-          } else if (typeof item === "string") {
-            results.push({ url: item });
-          }
-        }
-        out[key] = results;
-      }
-    }
+    if (data.web) out.web = transformArray(data.web);
+    if (data.news) out.news = transformArray(data.news);
+    if (data.images) out.images = transformArray(data.images);
     return out;
   } catch (err) {
     if (err?.isAxiosError) return normalizeAxiosError(err, "search");
@@ -2355,7 +2356,7 @@ var Firecrawl = class extends FirecrawlClient {
     return this._v1;
   }
 };
-var index_default = Firecrawl;
+var src_default = Firecrawl;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Firecrawl,

package/dist/index.d.cts

@@ -138,21 +138,43 @@ interface Document {
     warning?: string;
     changeTracking?: Record<string, unknown>;
 }
-interface SearchResult {
+interface SearchResultWeb {
     url: string;
     title?: string;
     description?: string;
+    category?: string;
+}
+interface SearchResultNews {
+    title?: string;
+    url?: string;
+    snippet?: string;
+    date?: string;
+    imageUrl?: string;
+    position?: number;
+    category?: string;
+}
+interface SearchResultImages {
+    title?: string;
+    imageUrl?: string;
+    imageWidth?: number;
+    imageHeight?: number;
+    url?: string;
+    position?: number;
 }
 interface SearchData {
-    web?: Array<SearchResult | Document>;
-    news?: Array<SearchResult | Document>;
-    images?: Array<SearchResult | Document>;
+    web?: Array<SearchResultWeb | Document>;
+    news?: Array<SearchResultNews | Document>;
+    images?: Array<SearchResultImages | Document>;
+}
+interface CategoryOption {
+    type: "github" | "research";
 }
 interface SearchRequest {
     query: string;
     sources?: Array<"web" | "news" | "images" | {
         type: "web" | "news" | "images";
     }>;
+    categories?: Array<"github" | "research" | CategoryOption>;
     limit?: number;
     tbs?: string;
     location?: string;
@@ -215,7 +237,7 @@ interface BatchScrapeJob {
     data: Document[];
 }
 interface MapData {
-    links: SearchResult[];
+    links: SearchResultWeb[];
 }
 interface MapOptions {
     search?: string;
@@ -1326,4 +1348,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, 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 Format, type FormatOption, type FormatString, type JsonFormat, type LocationConfig, type MapData, type MapOptions, type PDFAction, type PressAction, type ScrapeAction, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResult, type TokenUsage, type Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, 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 Format, type FormatOption, type FormatString, type JsonFormat, type LocationConfig, type MapData, type MapOptions, type PDFAction, 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 };

package/dist/index.d.ts

@@ -138,21 +138,43 @@ interface Document {
     warning?: string;
     changeTracking?: Record<string, unknown>;
 }
-interface SearchResult {
+interface SearchResultWeb {
     url: string;
     title?: string;
     description?: string;
+    category?: string;
+}
+interface SearchResultNews {
+    title?: string;
+    url?: string;
+    snippet?: string;
+    date?: string;
+    imageUrl?: string;
+    position?: number;
+    category?: string;
+}
+interface SearchResultImages {
+    title?: string;
+    imageUrl?: string;
+    imageWidth?: number;
+    imageHeight?: number;
+    url?: string;
+    position?: number;
 }
 interface SearchData {
-    web?: Array<SearchResult | Document>;
-    news?: Array<SearchResult | Document>;
-    images?: Array<SearchResult | Document>;
+    web?: Array<SearchResultWeb | Document>;
+    news?: Array<SearchResultNews | Document>;
+    images?: Array<SearchResultImages | Document>;
+}
+interface CategoryOption {
+    type: "github" | "research";
 }
 interface SearchRequest {
     query: string;
     sources?: Array<"web" | "news" | "images" | {
         type: "web" | "news" | "images";
     }>;
+    categories?: Array<"github" | "research" | CategoryOption>;
     limit?: number;
     tbs?: string;
     location?: string;
@@ -215,7 +237,7 @@ interface BatchScrapeJob {
     data: Document[];
 }
 interface MapData {
-    links: SearchResult[];
+    links: SearchResultWeb[];
 }
 interface MapOptions {
     search?: string;
@@ -1326,4 +1348,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type BatchScrapeJob, type BatchScrapeOptions, type BatchScrapeResponse$1 as BatchScrapeResponse, 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 Format, type FormatOption, type FormatString, type JsonFormat, type LocationConfig, type MapData, type MapOptions, type PDFAction, type PressAction, type ScrapeAction, type ScrapeOptions, type ScreenshotAction, type ScreenshotFormat, type ScrollAction, SdkError, type SearchData, type SearchRequest, type SearchResult, type TokenUsage, type Viewport, type WaitAction, type WebhookConfig, type WriteAction, Firecrawl as default };
+export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, 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 Format, type FormatOption, type FormatString, type JsonFormat, type LocationConfig, type MapData, type MapOptions, type PDFAction, 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 };

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-OIZ6OKY4.js";
+} from "./chunk-NVTWBXZM.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -200,6 +200,7 @@ function prepareSearchPayload(req) {
     query: req.query
   };
   if (req.sources) payload.sources = req.sources;
+  if (req.categories) payload.categories = req.categories;
   if (req.limit != null) payload.limit = req.limit;
   if (req.tbs != null) payload.tbs = req.tbs;
   if (req.location != null) payload.location = req.location;
@@ -211,6 +212,21 @@ function prepareSearchPayload(req) {
   }
   return payload;
 }
+function transformArray(arr) {
+  const results = [];
+  for (const item of arr) {
+    if (item && typeof item === "object") {
+      if ("markdown" in item || "html" in item || "rawHtml" in item || "links" in item || "screenshot" in item || "changeTracking" in item || "summary" in item || "json" in item) {
+        results.push(item);
+      } else {
+        results.push(item);
+      }
+    } else {
+      results.push({ url: item });
+    }
+  }
+  return results;
+}
 async function search(http, request) {
   const payload = prepareSearchPayload(request);
   try {
@@ -220,24 +236,9 @@ async function search(http, request) {
     }
     const data = res.data.data || {};
     const out = {};
-    for (const key of Object.keys(data)) {
-      const arr = data[key];
-      if (Array.isArray(arr)) {
-        const results = [];
-        for (const item of arr) {
-          if (item && typeof item === "object") {
-            if ("markdown" in item || "html" in item || "rawHtml" in item || "links" in item || "screenshot" in item || "changeTracking" in item || "summary" in item || "json" in item) {
-              results.push(item);
-            } else {
-              results.push({ url: item.url, title: item.title, description: item.description });
-            }
-          } else if (typeof item === "string") {
-            results.push({ url: item });
-          }
-        }
-        out[key] = results;
-      }
-    }
+    if (data.web) out.web = transformArray(data.web);
+    if (data.news) out.news = transformArray(data.news);
+    if (data.images) out.images = transformArray(data.images);
     return out;
   } catch (err) {
     if (err?.isAxiosError) return normalizeAxiosError(err, "search");
@@ -932,7 +933,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-V5IPFKBE.js");
+      const packageJson = await import("./package-TM3XCIRK.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);
@@ -2239,11 +2240,11 @@ var Firecrawl = class extends FirecrawlClient {
     return this._v1;
   }
 };
-var index_default = Firecrawl;
+var src_default = Firecrawl;
 export {
   Firecrawl,
   FirecrawlApp as FirecrawlAppV1,
   FirecrawlClient,
   SdkError,
-  index_default as default
+  src_default as default
 };

package/dist/{package-V5IPFKBE.js → package-TM3XCIRK.js}

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

package/package.json

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

package/src/__tests__/unit/v2/validation.test.ts

@@ -9,11 +9,18 @@ describe("v2 utils: validation", () => {
     expect(() => ensureValidFormats(formats)).toThrow(/json format must be an object/i);
   });
 
-  test("ensureValidFormats: json format requires prompt and schema", () => {
-    const bad1: FormatOption[] = [{ type: "json", prompt: "p" } as any];
-    const bad2: FormatOption[] = [{ type: "json", schema: {} } as any];
-    expect(() => ensureValidFormats(bad1)).toThrow(/requires 'prompt' and 'schema'/i);
-    expect(() => ensureValidFormats(bad2)).toThrow(/requires 'prompt' and 'schema'/i);
+  test("ensureValidFormats: json format requires prompt or schema", () => {
+    // Valid cases - should not throw
+    const valid1: FormatOption[] = [{ type: "json", prompt: "p" } as any];
+    const valid2: FormatOption[] = [{ type: "json", schema: {} } as any];
+    const valid3: FormatOption[] = [{ type: "json", prompt: "p", schema: {} } as any];
+    expect(() => ensureValidFormats(valid1)).not.toThrow();
+    expect(() => ensureValidFormats(valid2)).not.toThrow();
+    expect(() => ensureValidFormats(valid3)).not.toThrow();
+
+    // Invalid case - should throw when both are missing
+    const bad: FormatOption[] = [{ type: "json" } as any];
+    expect(() => ensureValidFormats(bad)).toThrow(/requires either 'prompt' or 'schema'/i);
   });
 
   test("ensureValidFormats: converts zod schema to JSON schema", () => {

package/src/v2/methods/search.ts

@@ -1,4 +1,4 @@
-import { type Document, type SearchData, type SearchRequest, type SearchResult, type ScrapeOptions } from "../types";
+import { type Document, type SearchData, type SearchRequest, type SearchResultWeb, type ScrapeOptions, type SearchResultNews, type SearchResultImages } from "../types";
 import { HttpClient } from "../utils/httpClient";
 import { ensureValidScrapeOptions } from "../utils/validation";
 import { throwForBadResponse, normalizeAxiosError } from "../utils/errorHandler";
@@ -11,6 +11,7 @@ function prepareSearchPayload(req: SearchRequest): Record<string, unknown> {
     query: req.query,
   };
   if (req.sources) payload.sources = req.sources;
+  if (req.categories) payload.categories = req.categories;
   if (req.limit != null) payload.limit = req.limit;
   if (req.tbs != null) payload.tbs = req.tbs;
   if (req.location != null) payload.location = req.location;
@@ -23,6 +24,31 @@ function prepareSearchPayload(req: SearchRequest): Record<string, unknown> {
   return payload;
 }
 
+function transformArray<ResultType>(arr: any[]): Array<ResultType | Document> {
+  const results: Array<ResultType | Document> = [] as any;
+  for (const item of arr) {
+    if (item && typeof item === "object") {
+      if (
+        "markdown" in item ||
+        "html" in item ||
+        "rawHtml" in item ||
+        "links" in item ||
+        "screenshot" in item ||
+        "changeTracking" in item ||
+        "summary" in item ||
+        "json" in item
+      ) {
+        results.push(item as Document);
+      } else {
+        results.push(item as ResultType);
+      }
+    } else {
+      results.push({ url: item } as ResultType);
+    }
+  }
+  return results;
+}
+
 export async function search(http: HttpClient, request: SearchRequest): Promise<SearchData> {
   const payload = prepareSearchPayload(request);
   try {
@@ -32,34 +58,9 @@ export async function search(http: HttpClient, request: SearchRequest): Promise<
     }
     const data = (res.data.data || {}) as Record<string, any>;
     const out: SearchData = {};
-    for (const key of Object.keys(data)) {
-      const arr = data[key];
-      if (Array.isArray(arr)) {
-        const results: Array<SearchResult | Document> = [] as any;
-        for (const item of arr) {
-          if (item && typeof item === "object") {
-            // If scraped page fields present, treat as Document; otherwise SearchResult
-            if (
-              "markdown" in item ||
-              "html" in item ||
-              "rawHtml" in item ||
-              "links" in item ||
-              "screenshot" in item ||
-              "changeTracking" in item ||
-              "summary" in item ||
-              "json" in item
-            ) {
-              results.push(item as Document);
-            } else {
-              results.push({ url: item.url, title: item.title, description: item.description } as SearchResult);
-            }
-          } else if (typeof item === "string") {
-            results.push({ url: item } as SearchResult);
-          }
-        }
-        (out as any)[key] = results;
-      }
-    }
+    if (data.web) out.web = transformArray<SearchResultWeb>(data.web);
+    if (data.news) out.news = transformArray<SearchResultNews>(data.news);
+    if (data.images) out.images = transformArray<SearchResultImages>(data.images);
     return out;
   } catch (err: any) {
     if (err?.isAxiosError) return normalizeAxiosError(err, "search");

package/src/v2/types.ts

@@ -173,21 +173,46 @@ export interface Document {
   changeTracking?: Record<string, unknown>;
 }
 
-export interface SearchResult {
+export interface SearchResultWeb {
   url: string;
   title?: string;
   description?: string;
+  category?: string;
+}
+
+export interface SearchResultNews {
+  title?: string;
+  url?: string;
+  snippet?: string;
+  date?: string;
+  imageUrl?: string;
+  position?: number;
+  category?: string;
+}
+
+export interface SearchResultImages {
+  title?: string;
+  imageUrl?: string;
+  imageWidth?: number;
+  imageHeight?: number;
+  url?: string;
+  position?: number;
 }
 
 export interface SearchData {
-  web?: Array<SearchResult | Document>;
-  news?: Array<SearchResult | Document>;
-  images?: Array<SearchResult | Document>;
+  web?: Array<SearchResultWeb | Document>;
+  news?: Array<SearchResultNews | Document>;
+  images?: Array<SearchResultImages | Document>;
+}
+
+export interface CategoryOption {
+  type: "github" | "research";
 }
 
 export interface SearchRequest {
   query: string;
   sources?: Array<"web" | "news" | "images" | { type: "web" | "news" | "images" }>;
+  categories?: Array<"github" | "research" | CategoryOption>;
   limit?: number;
   tbs?: string;
   location?: string;
@@ -257,7 +282,7 @@ export interface BatchScrapeJob {
 }
 
 export interface MapData {
-  links: SearchResult[];
+  links: SearchResultWeb[];
 }
 
 export interface MapOptions {