firecrawl 3.0.2 → 3.1.0

package/dist/{chunk-JFWW4BWA.js → chunk-WNGXI3ZW.js}

@@ -7,8 +7,8 @@ var __commonJS = (cb, mod) => function __require() {
 var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
-      name: "firecrawl",
-      version: "3.0.2",
+      name: "@mendable/firecrawl-js",
+      version: "3.1.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: "firecrawl",
-      version: "3.0.2",
+      name: "@mendable/firecrawl-js",
+      version: "3.1.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 src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   Firecrawl: () => Firecrawl,
   FirecrawlAppV1: () => FirecrawlApp,
   FirecrawlClient: () => FirecrawlClient,
   SdkError: () => SdkError,
-  default: () => src_default
+  default: () => index_default
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/v2/utils/httpClient.ts
 var import_axios = __toESM(require("axios"), 1);
@@ -327,6 +327,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 +351,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");
@@ -826,6 +826,7 @@ var Watcher = class extends import_events.EventEmitter {
 };
 
 // src/v2/client.ts
+var zt = require("zod");
 var FirecrawlClient = class {
   http;
   /**
@@ -1015,7 +1016,7 @@ var FirecrawlClient = class {
 
 // src/v1/index.ts
 var import_axios3 = __toESM(require("axios"), 1);
-var zt = require("zod");
+var zt2 = require("zod");
 var import_zod_to_json_schema3 = require("zod-to-json-schema");
 
 // node_modules/typescript-event-target/dist/index.mjs
@@ -2354,7 +2355,7 @@ var Firecrawl = class extends FirecrawlClient {
     return this._v1;
   }
 };
-var src_default = Firecrawl;
+var index_default = Firecrawl;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Firecrawl,

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as zt from 'zod';
-import { ZodTypeAny, infer } from 'zod';
+import { ZodTypeAny } from 'zod';
 import { AxiosResponse, AxiosRequestHeaders } from 'axios';
 import { EventEmitter } from 'events';
 import { TypedEventTarget } from 'typescript-event-target';
@@ -138,15 +138,31 @@ interface Document {
     warning?: string;
     changeTracking?: Record<string, unknown>;
 }
-interface SearchResult {
+interface SearchResultWeb {
     url: string;
     title?: string;
     description?: string;
 }
+interface SearchResultNews {
+    title?: string;
+    url?: string;
+    snippet?: string;
+    date?: string;
+    imageUrl?: string;
+    position?: number;
+}
+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 SearchRequest {
     query: string;
@@ -160,6 +176,23 @@ interface SearchRequest {
     timeout?: number;
     scrapeOptions?: ScrapeOptions;
 }
+interface CrawlOptions {
+    prompt?: string | null;
+    excludePaths?: string[] | null;
+    includePaths?: string[] | null;
+    maxDiscoveryDepth?: number | null;
+    sitemap?: "skip" | "include";
+    ignoreQueryParameters?: boolean;
+    limit?: number | null;
+    crawlEntireDomain?: boolean;
+    allowExternalLinks?: boolean;
+    allowSubdomains?: boolean;
+    delay?: number | null;
+    maxConcurrency?: number | null;
+    webhook?: string | WebhookConfig | null;
+    scrapeOptions?: ScrapeOptions | null;
+    zeroDataRetention?: boolean;
+}
 interface CrawlResponse$1 {
     id: string;
     url: string;
@@ -173,6 +206,16 @@ interface CrawlJob {
     next?: string | null;
     data: Document[];
 }
+interface BatchScrapeOptions {
+    options?: ScrapeOptions;
+    webhook?: string | WebhookConfig;
+    appendToId?: string;
+    ignoreInvalidURLs?: boolean;
+    maxConcurrency?: number;
+    zeroDataRetention?: boolean;
+    integration?: string;
+    idempotencyKey?: string;
+}
 interface BatchScrapeResponse$1 {
     id: string;
     url: string;
@@ -188,7 +231,7 @@ interface BatchScrapeJob {
     data: Document[];
 }
 interface MapData {
-    links: SearchResult[];
+    links: SearchResultWeb[];
 }
 interface MapOptions {
     search?: string;
@@ -274,38 +317,6 @@ declare class HttpClient {
     prepareHeaders(idempotencyKey?: string): Record<string, string>;
 }
 
-interface CrawlRequest {
-    url: string;
-    prompt?: string | null;
-    excludePaths?: string[] | null;
-    includePaths?: string[] | null;
-    maxDiscoveryDepth?: number | null;
-    sitemap?: "skip" | "include";
-    ignoreQueryParameters?: boolean;
-    limit?: number | null;
-    crawlEntireDomain?: boolean;
-    allowExternalLinks?: boolean;
-    allowSubdomains?: boolean;
-    delay?: number | null;
-    maxConcurrency?: number | null;
-    webhook?: string | WebhookConfig | null;
-    scrapeOptions?: ScrapeOptions | null;
-    zeroDataRetention?: boolean;
-}
-declare function startCrawl(http: HttpClient, request: CrawlRequest): Promise<CrawlResponse$1>;
-
-interface StartBatchOptions {
-    options?: ScrapeOptions;
-    webhook?: string | WebhookConfig;
-    appendToId?: string;
-    ignoreInvalidURLs?: boolean;
-    maxConcurrency?: number;
-    zeroDataRetention?: boolean;
-    integration?: string;
-    idempotencyKey?: string;
-}
-declare function startBatchScrape(http: HttpClient, urls: string[], { options, webhook, appendToId, ignoreInvalidURLs, maxConcurrency, zeroDataRetention, integration, idempotencyKey, }?: StartBatchOptions): Promise<BatchScrapeResponse$1>;
-
 declare function prepareExtractPayload(args: {
     urls?: string[];
     prompt?: string;
@@ -349,7 +360,7 @@ type ExtractJsonSchemaFromFormats<Formats> = Formats extends readonly any[] ? Ex
 }>["schema"] : never;
 type InferredJsonFromOptions<Opts> = Opts extends {
     formats?: infer Fmts;
-} ? ExtractJsonSchemaFromFormats<Fmts> extends ZodTypeAny ? infer<ExtractJsonSchemaFromFormats<Fmts>> : unknown : unknown;
+} ? ExtractJsonSchemaFromFormats<Fmts> extends zt.ZodTypeAny ? zt.infer<ExtractJsonSchemaFromFormats<Fmts>> : unknown : unknown;
 /**
  * Configuration for the v2 client transport.
  */
@@ -405,7 +416,7 @@ declare class FirecrawlClient {
      * @param req Crawl configuration (paths, limits, scrapeOptions, webhook, etc.).
      * @returns Job id and url.
      */
-    startCrawl(url: string, req?: Omit<Parameters<typeof startCrawl>[1], "url">): Promise<CrawlResponse$1>;
+    startCrawl(url: string, req?: CrawlOptions): Promise<CrawlResponse$1>;
     /**
      * Get the status and partial data of a crawl job.
      * @param jobId Crawl job id.
@@ -423,7 +434,7 @@ declare class FirecrawlClient {
      * @param req Crawl configuration plus waiter controls (pollInterval, timeout seconds).
      * @returns Final job snapshot.
      */
-    crawl(url: string, req?: Omit<Parameters<typeof startCrawl>[1], "url"> & {
+    crawl(url: string, req?: CrawlOptions & {
         pollInterval?: number;
         timeout?: number;
     }): Promise<CrawlJob>;
@@ -448,7 +459,7 @@ declare class FirecrawlClient {
      * @param opts Batch options (scrape options, webhook, concurrency, idempotency key, etc.).
      * @returns Job id and url.
      */
-    startBatchScrape(urls: string[], opts?: Parameters<typeof startBatchScrape>[2]): Promise<BatchScrapeResponse$1>;
+    startBatchScrape(urls: string[], opts?: BatchScrapeOptions): Promise<BatchScrapeResponse$1>;
     /**
      * Get the status and partial data of a batch scrape job.
      * @param jobId Batch job id.
@@ -471,7 +482,7 @@ declare class FirecrawlClient {
      * @param opts Batch options plus waiter controls (pollInterval, timeout seconds).
      * @returns Final job snapshot.
      */
-    batchScrape(urls: string[], opts?: Parameters<typeof startBatchScrape>[2] & {
+    batchScrape(urls: string[], opts?: BatchScrapeOptions & {
         pollInterval?: number;
         timeout?: number;
     }): Promise<BatchScrapeJob>;
@@ -1331,4 +1342,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type BatchScrapeJob, type BatchScrapeResponse$1 as BatchScrapeResponse, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, 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 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

@@ -1,5 +1,5 @@
 import * as zt from 'zod';
-import { ZodTypeAny, infer } from 'zod';
+import { ZodTypeAny } from 'zod';
 import { AxiosResponse, AxiosRequestHeaders } from 'axios';
 import { EventEmitter } from 'events';
 import { TypedEventTarget } from 'typescript-event-target';
@@ -138,15 +138,31 @@ interface Document {
     warning?: string;
     changeTracking?: Record<string, unknown>;
 }
-interface SearchResult {
+interface SearchResultWeb {
     url: string;
     title?: string;
     description?: string;
 }
+interface SearchResultNews {
+    title?: string;
+    url?: string;
+    snippet?: string;
+    date?: string;
+    imageUrl?: string;
+    position?: number;
+}
+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 SearchRequest {
     query: string;
@@ -160,6 +176,23 @@ interface SearchRequest {
     timeout?: number;
     scrapeOptions?: ScrapeOptions;
 }
+interface CrawlOptions {
+    prompt?: string | null;
+    excludePaths?: string[] | null;
+    includePaths?: string[] | null;
+    maxDiscoveryDepth?: number | null;
+    sitemap?: "skip" | "include";
+    ignoreQueryParameters?: boolean;
+    limit?: number | null;
+    crawlEntireDomain?: boolean;
+    allowExternalLinks?: boolean;
+    allowSubdomains?: boolean;
+    delay?: number | null;
+    maxConcurrency?: number | null;
+    webhook?: string | WebhookConfig | null;
+    scrapeOptions?: ScrapeOptions | null;
+    zeroDataRetention?: boolean;
+}
 interface CrawlResponse$1 {
     id: string;
     url: string;
@@ -173,6 +206,16 @@ interface CrawlJob {
     next?: string | null;
     data: Document[];
 }
+interface BatchScrapeOptions {
+    options?: ScrapeOptions;
+    webhook?: string | WebhookConfig;
+    appendToId?: string;
+    ignoreInvalidURLs?: boolean;
+    maxConcurrency?: number;
+    zeroDataRetention?: boolean;
+    integration?: string;
+    idempotencyKey?: string;
+}
 interface BatchScrapeResponse$1 {
     id: string;
     url: string;
@@ -188,7 +231,7 @@ interface BatchScrapeJob {
     data: Document[];
 }
 interface MapData {
-    links: SearchResult[];
+    links: SearchResultWeb[];
 }
 interface MapOptions {
     search?: string;
@@ -274,38 +317,6 @@ declare class HttpClient {
     prepareHeaders(idempotencyKey?: string): Record<string, string>;
 }
 
-interface CrawlRequest {
-    url: string;
-    prompt?: string | null;
-    excludePaths?: string[] | null;
-    includePaths?: string[] | null;
-    maxDiscoveryDepth?: number | null;
-    sitemap?: "skip" | "include";
-    ignoreQueryParameters?: boolean;
-    limit?: number | null;
-    crawlEntireDomain?: boolean;
-    allowExternalLinks?: boolean;
-    allowSubdomains?: boolean;
-    delay?: number | null;
-    maxConcurrency?: number | null;
-    webhook?: string | WebhookConfig | null;
-    scrapeOptions?: ScrapeOptions | null;
-    zeroDataRetention?: boolean;
-}
-declare function startCrawl(http: HttpClient, request: CrawlRequest): Promise<CrawlResponse$1>;
-
-interface StartBatchOptions {
-    options?: ScrapeOptions;
-    webhook?: string | WebhookConfig;
-    appendToId?: string;
-    ignoreInvalidURLs?: boolean;
-    maxConcurrency?: number;
-    zeroDataRetention?: boolean;
-    integration?: string;
-    idempotencyKey?: string;
-}
-declare function startBatchScrape(http: HttpClient, urls: string[], { options, webhook, appendToId, ignoreInvalidURLs, maxConcurrency, zeroDataRetention, integration, idempotencyKey, }?: StartBatchOptions): Promise<BatchScrapeResponse$1>;
-
 declare function prepareExtractPayload(args: {
     urls?: string[];
     prompt?: string;
@@ -349,7 +360,7 @@ type ExtractJsonSchemaFromFormats<Formats> = Formats extends readonly any[] ? Ex
 }>["schema"] : never;
 type InferredJsonFromOptions<Opts> = Opts extends {
     formats?: infer Fmts;
-} ? ExtractJsonSchemaFromFormats<Fmts> extends ZodTypeAny ? infer<ExtractJsonSchemaFromFormats<Fmts>> : unknown : unknown;
+} ? ExtractJsonSchemaFromFormats<Fmts> extends zt.ZodTypeAny ? zt.infer<ExtractJsonSchemaFromFormats<Fmts>> : unknown : unknown;
 /**
  * Configuration for the v2 client transport.
  */
@@ -405,7 +416,7 @@ declare class FirecrawlClient {
      * @param req Crawl configuration (paths, limits, scrapeOptions, webhook, etc.).
      * @returns Job id and url.
      */
-    startCrawl(url: string, req?: Omit<Parameters<typeof startCrawl>[1], "url">): Promise<CrawlResponse$1>;
+    startCrawl(url: string, req?: CrawlOptions): Promise<CrawlResponse$1>;
     /**
      * Get the status and partial data of a crawl job.
      * @param jobId Crawl job id.
@@ -423,7 +434,7 @@ declare class FirecrawlClient {
      * @param req Crawl configuration plus waiter controls (pollInterval, timeout seconds).
      * @returns Final job snapshot.
      */
-    crawl(url: string, req?: Omit<Parameters<typeof startCrawl>[1], "url"> & {
+    crawl(url: string, req?: CrawlOptions & {
         pollInterval?: number;
         timeout?: number;
     }): Promise<CrawlJob>;
@@ -448,7 +459,7 @@ declare class FirecrawlClient {
      * @param opts Batch options (scrape options, webhook, concurrency, idempotency key, etc.).
      * @returns Job id and url.
      */
-    startBatchScrape(urls: string[], opts?: Parameters<typeof startBatchScrape>[2]): Promise<BatchScrapeResponse$1>;
+    startBatchScrape(urls: string[], opts?: BatchScrapeOptions): Promise<BatchScrapeResponse$1>;
     /**
      * Get the status and partial data of a batch scrape job.
      * @param jobId Batch job id.
@@ -471,7 +482,7 @@ declare class FirecrawlClient {
      * @param opts Batch options plus waiter controls (pollInterval, timeout seconds).
      * @returns Final job snapshot.
      */
-    batchScrape(urls: string[], opts?: Parameters<typeof startBatchScrape>[2] & {
+    batchScrape(urls: string[], opts?: BatchScrapeOptions & {
         pollInterval?: number;
         timeout?: number;
     }): Promise<BatchScrapeJob>;
@@ -1331,4 +1342,4 @@ declare class Firecrawl extends FirecrawlClient {
     get v1(): FirecrawlApp;
 }
 
-export { type ActionOption, type ActiveCrawl, type ActiveCrawlsResponse, type BatchScrapeJob, type BatchScrapeResponse$1 as BatchScrapeResponse, type ChangeTrackingFormat, type ClickAction, type ConcurrencyCheck, type CrawlErrorsResponse$1 as CrawlErrorsResponse, type CrawlJob, 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 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-JFWW4BWA.js";
+} from "./chunk-WNGXI3ZW.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -211,6 +211,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 +235,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");
@@ -710,6 +710,7 @@ var Watcher = class extends EventEmitter {
 };
 
 // src/v2/client.ts
+import "zod";
 var FirecrawlClient = class {
   http;
   /**
@@ -931,7 +932,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-KYZ3HXR5.js");
+      const packageJson = await import("./package-KMFB7KZD.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);
@@ -2238,11 +2239,11 @@ var Firecrawl = class extends FirecrawlClient {
     return this._v1;
   }
 };
-var src_default = Firecrawl;
+var index_default = Firecrawl;
 export {
   Firecrawl,
   FirecrawlApp as FirecrawlAppV1,
   FirecrawlClient,
   SdkError,
-  src_default as default
+  index_default as default
 };

package/dist/{package-KYZ3HXR5.js → package-KMFB7KZD.js}

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

package/package.json

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

package/src/v2/client.ts

@@ -34,10 +34,12 @@ import type {
   BatchScrapeResponse,
   BatchScrapeJob,
   ExtractResponse,
+  CrawlOptions,
+  BatchScrapeOptions,
 } from "./types";
 import { Watcher } from "./watcher";
 import type { WatcherOptions } from "./watcher";
-import type { ZodTypeAny, infer as ZodInfer } from "zod";
+import * as zt from "zod";
 
 // Helper types to infer the `json` field from a Zod schema included in `formats`
 type ExtractJsonSchemaFromFormats<Formats> = Formats extends readonly any[]
@@ -45,8 +47,8 @@ type ExtractJsonSchemaFromFormats<Formats> = Formats extends readonly any[]
   : never;
 
 type InferredJsonFromOptions<Opts> = Opts extends { formats?: infer Fmts }
-  ? ExtractJsonSchemaFromFormats<Fmts> extends ZodTypeAny
-    ? ZodInfer<ExtractJsonSchemaFromFormats<Fmts>>
+  ? ExtractJsonSchemaFromFormats<Fmts> extends zt.ZodTypeAny
+    ? zt.infer<ExtractJsonSchemaFromFormats<Fmts>>
     : unknown
   : unknown;
 
@@ -136,8 +138,8 @@ export class FirecrawlClient {
    * @param req Crawl configuration (paths, limits, scrapeOptions, webhook, etc.).
    * @returns Job id and url.
    */
-  async startCrawl(url: string, req: Omit<Parameters<typeof startCrawl>[1], "url"> = {}): Promise<CrawlResponse> {
-    return startCrawl(this.http, { url, ...(req as any) });
+  async startCrawl(url: string, req: CrawlOptions = {}): Promise<CrawlResponse> {
+    return startCrawl(this.http, { url, ...req });
   }
   /**
    * Get the status and partial data of a crawl job.
@@ -160,8 +162,8 @@ export class FirecrawlClient {
    * @param req Crawl configuration plus waiter controls (pollInterval, timeout seconds).
    * @returns Final job snapshot.
    */
-  async crawl(url: string, req: Omit<Parameters<typeof startCrawl>[1], "url"> & { pollInterval?: number; timeout?: number } = {}): Promise<CrawlJob> {
-    return crawlWaiter(this.http, { url, ...(req as any) }, req.pollInterval, req.timeout);
+  async crawl(url: string, req: CrawlOptions & { pollInterval?: number; timeout?: number } = {}): Promise<CrawlJob> {
+    return crawlWaiter(this.http, { url, ...req }, req.pollInterval, req.timeout);
   }
   /**
    * Retrieve crawl errors and robots.txt blocks.
@@ -192,7 +194,7 @@ export class FirecrawlClient {
    * @param opts Batch options (scrape options, webhook, concurrency, idempotency key, etc.).
    * @returns Job id and url.
    */
-  async startBatchScrape(urls: string[], opts?: Parameters<typeof startBatchScrape>[2]): Promise<BatchScrapeResponse> {
+  async startBatchScrape(urls: string[], opts?: BatchScrapeOptions): Promise<BatchScrapeResponse> {
     return startBatchScrape(this.http, urls, opts);
   }
   /**
@@ -223,7 +225,7 @@ export class FirecrawlClient {
    * @param opts Batch options plus waiter controls (pollInterval, timeout seconds).
    * @returns Final job snapshot.
    */
-  async batchScrape(urls: string[], opts?: Parameters<typeof startBatchScrape>[2] & { pollInterval?: number; timeout?: number }): Promise<BatchScrapeJob> {
+  async batchScrape(urls: string[], opts?: BatchScrapeOptions & { pollInterval?: number; timeout?: number }): Promise<BatchScrapeJob> {
     return batchWaiter(this.http, urls, opts);
   }
 

package/src/v2/methods/batch.ts

@@ -3,24 +3,12 @@ import {
   type BatchScrapeResponse,
   type CrawlErrorsResponse,
   type Document,
-  type ScrapeOptions,
-  type WebhookConfig,
+  type BatchScrapeOptions,
 } from "../types";
 import { HttpClient } from "../utils/httpClient";
 import { ensureValidScrapeOptions } from "../utils/validation";
 import { normalizeAxiosError, throwForBadResponse } from "../utils/errorHandler";
 
-export interface StartBatchOptions {
-  options?: ScrapeOptions;
-  webhook?: string | WebhookConfig;
-  appendToId?: string;
-  ignoreInvalidURLs?: boolean;
-  maxConcurrency?: number;
-  zeroDataRetention?: boolean;
-  integration?: string;
-  idempotencyKey?: string;
-}
-
 export async function startBatchScrape(
   http: HttpClient,
   urls: string[],
@@ -33,7 +21,7 @@ export async function startBatchScrape(
     zeroDataRetention,
     integration,
     idempotencyKey,
-  }: StartBatchOptions = {}
+  }: BatchScrapeOptions = {}
 ): Promise<BatchScrapeResponse> {
   if (!Array.isArray(urls) || urls.length === 0) throw new Error("URLs list cannot be empty");
   const payload: Record<string, unknown> = { urls };
@@ -117,7 +105,7 @@ export async function waitForBatchCompletion(http: HttpClient, jobId: string, po
 export async function batchScrape(
   http: HttpClient,
   urls: string[],
-  opts: StartBatchOptions & { pollInterval?: number; timeout?: number } = {}
+  opts: BatchScrapeOptions & { pollInterval?: number; timeout?: number } = {}
 ): Promise<BatchScrapeJob> {
   const start = await startBatchScrape(http, urls, opts);
   return waitForBatchCompletion(http, start.id, opts.pollInterval ?? 2, opts.timeout);

package/src/v2/methods/crawl.ts

@@ -4,31 +4,15 @@ import {
   type CrawlJob,
   type CrawlResponse,
   type Document,
-  type ScrapeOptions,
-  type WebhookConfig,
+  type CrawlOptions,
 } from "../types";
 import { HttpClient } from "../utils/httpClient";
 import { ensureValidScrapeOptions } from "../utils/validation";
 import { normalizeAxiosError, throwForBadResponse } from "../utils/errorHandler";
 
-export interface CrawlRequest {
+export type CrawlRequest = CrawlOptions & {
   url: string;
-  prompt?: string | null;
-  excludePaths?: string[] | null;
-  includePaths?: string[] | null;
-  maxDiscoveryDepth?: number | null;
-  sitemap?: "skip" | "include";
-  ignoreQueryParameters?: boolean;
-  limit?: number | null;
-  crawlEntireDomain?: boolean;
-  allowExternalLinks?: boolean;
-  allowSubdomains?: boolean;
-  delay?: number | null;
-  maxConcurrency?: number | null;
-  webhook?: string | WebhookConfig | null;
-  scrapeOptions?: ScrapeOptions | null;
-  zeroDataRetention?: boolean;
-}
+};
 
 function prepareCrawlPayload(request: CrawlRequest): Record<string, unknown> {
   if (!request.url || !request.url.trim()) throw new Error("URL cannot be empty");

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";
@@ -23,6 +23,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 +57,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,16 +173,34 @@ export interface Document {
   changeTracking?: Record<string, unknown>;
 }
 
-export interface SearchResult {
+export interface SearchResultWeb {
   url: string;
   title?: string;
   description?: string;
 }
 
+export interface SearchResultNews {
+  title?: string;
+  url?: string;
+  snippet?: string;
+  date?: string;
+  imageUrl?: string;
+  position?: number;
+}
+
+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 SearchRequest {
@@ -196,6 +214,24 @@ export interface SearchRequest {
   scrapeOptions?: ScrapeOptions;
 }
 
+export interface CrawlOptions {
+  prompt?: string | null;
+  excludePaths?: string[] | null;
+  includePaths?: string[] | null;
+  maxDiscoveryDepth?: number | null;
+  sitemap?: "skip" | "include";
+  ignoreQueryParameters?: boolean;
+  limit?: number | null;
+  crawlEntireDomain?: boolean;
+  allowExternalLinks?: boolean;
+  allowSubdomains?: boolean;
+  delay?: number | null;
+  maxConcurrency?: number | null;
+  webhook?: string | WebhookConfig | null;
+  scrapeOptions?: ScrapeOptions | null;
+  zeroDataRetention?: boolean;
+}
+
 export interface CrawlResponse {
   id: string;
   url: string;
@@ -211,6 +247,17 @@ export interface CrawlJob {
   data: Document[];
 }
 
+export interface BatchScrapeOptions {
+  options?: ScrapeOptions;
+  webhook?: string | WebhookConfig;
+  appendToId?: string;
+  ignoreInvalidURLs?: boolean;
+  maxConcurrency?: number;
+  zeroDataRetention?: boolean;
+  integration?: string;
+  idempotencyKey?: string;
+}
+
 export interface BatchScrapeResponse {
   id: string;
   url: string;
@@ -228,7 +275,7 @@ export interface BatchScrapeJob {
 }
 
 export interface MapData {
-  links: SearchResult[];
+  links: SearchResultWeb[];
 }
 
 export interface MapOptions {