firecrawl 4.30.0 → 4.31.0

package/dist/{chunk-OZ7DDARD.js → chunk-PSTSUWZW.js}

@@ -12,7 +12,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.30.0",
+      version: "4.31.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -39,7 +39,7 @@ var require_package = __commonJS({
       license: "MIT",
       dependencies: {
         axios: "1.18.0",
-        firecrawl: "4.16.0",
+        firecrawl: "4.30.1",
         "typescript-event-target": "^1.1.1",
         zod: "^3.23.8",
         "zod-to-json-schema": "^3.23.0"
@@ -81,7 +81,7 @@ var require_package = __commonJS({
           "rollup@<4.59.0": ">=4.59.0",
           "picomatch@<4.0.4": ">=4.0.4",
           handlebars: ">=4.7.9",
-          "brace-expansion": ">=5.0.6",
+          "brace-expansion@>=5.0.0 <5.0.7": "5.0.7",
           "js-yaml@>=3.0.0 <3.15.0": "3.15.0",
           "axios@>=1.0.0 <1.16.0": "1.16.1",
           "follow-redirects@<1.16.0": ">=1.16.0 <2.0.0",

package/dist/index.cjs

@@ -39,7 +39,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.30.0",
+      version: "4.31.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -66,7 +66,7 @@ var require_package = __commonJS({
       license: "MIT",
       dependencies: {
         axios: "1.18.0",
-        firecrawl: "4.16.0",
+        firecrawl: "4.30.1",
         "typescript-event-target": "^1.1.1",
         zod: "^3.23.8",
         "zod-to-json-schema": "^3.23.0"
@@ -108,7 +108,7 @@ var require_package = __commonJS({
           "rollup@<4.59.0": ">=4.59.0",
           "picomatch@<4.0.4": ">=4.0.4",
           handlebars: ">=4.7.9",
-          "brace-expansion": ">=5.0.6",
+          "brace-expansion@>=5.0.0 <5.0.7": "5.0.7",
           "js-yaml@>=3.0.0 <3.15.0": "3.15.0",
           "axios@>=1.0.0 <1.16.0": "1.16.1",
           "follow-redirects@<1.16.0": ">=1.16.0 <2.0.0",
@@ -717,6 +717,7 @@ function prepareSearchPayload(req) {
   if (req.ignoreInvalidURLs != null)
     payload.ignoreInvalidURLs = req.ignoreInvalidURLs;
   if (req.timeout != null) payload.timeout = req.timeout;
+  if (req.highlights != null) payload.highlights = req.highlights;
   if (req.integration && req.integration.trim())
     payload.integration = req.integration.trim();
   if (req.origin) payload.origin = req.origin;
@@ -801,6 +802,8 @@ function prepareMapPayload(url, options) {
     if (options.location != null) payload.location = options.location;
     if (options.threatProtection != null)
       payload.threatProtection = options.threatProtection;
+    if (options.auditMetadata != null)
+      payload.auditMetadata = options.auditMetadata;
   }
   return payload;
 }
@@ -1294,6 +1297,8 @@ function prepareAgentPayload(args) {
   if (args.webhook != null) body.webhook = args.webhook;
   if (args.threatProtection != null)
     body.threatProtection = args.threatProtection;
+  if (args.auditMetadata != null)
+    body.auditMetadata = args.auditMetadata;
   return body;
 }
 async function startAgent(http, args) {

package/dist/index.d.cts

@@ -142,6 +142,7 @@ interface ScrapeOptions {
     lockdown?: boolean;
     redactPII?: boolean | RedactPIIOptions;
     threatProtection?: ThreatProtectionOptions;
+    auditMetadata?: Record<string, string>;
     profile?: {
         name: string;
         saveChanges?: boolean;
@@ -544,6 +545,8 @@ interface SearchRequest {
     location?: string;
     ignoreInvalidURLs?: boolean;
     timeout?: number;
+    /** Generate query-relevant highlights for search results. Defaults to true. */
+    highlights?: boolean;
     scrapeOptions?: ScrapeOptions;
     /**
      * Enterprise search options. Use `["zdr"]` for end-to-end Zero Data
@@ -633,6 +636,7 @@ interface MapOptions {
     origin?: string;
     location?: LocationConfig$1;
     threatProtection?: ThreatProtectionOptions;
+    auditMetadata?: Record<string, string>;
 }
 type FeedbackRating = "good" | "partial" | "bad";
 type EndpointFeedbackEndpoint = "search" | "scrape" | "parse" | "map";
@@ -1292,6 +1296,7 @@ declare function prepareAgentPayload(args: {
     model?: "spark-1-pro" | "spark-1-mini";
     webhook?: string | AgentWebhookConfig;
     threatProtection?: ThreatProtectionOptions;
+    auditMetadata?: Record<string, string>;
 }): Record<string, unknown>;
 declare function startAgent(http: HttpClient, args: Parameters<typeof prepareAgentPayload>[0]): Promise<AgentResponse>;
 
@@ -1855,6 +1860,7 @@ interface CrawlScrapeOptions {
     storeInCache?: boolean;
     maxAge?: number;
     parsePDF?: boolean;
+    auditMetadata?: Record<string, string>;
 }
 type Action = {
     type: "wait";
@@ -2020,6 +2026,7 @@ interface MapParams {
     timeout?: number;
     useIndex?: boolean;
     location?: LocationConfig;
+    auditMetadata?: Record<string, string>;
 }
 /**
  * Response interface for mapping operations.

package/dist/index.d.ts

@@ -142,6 +142,7 @@ interface ScrapeOptions {
     lockdown?: boolean;
     redactPII?: boolean | RedactPIIOptions;
     threatProtection?: ThreatProtectionOptions;
+    auditMetadata?: Record<string, string>;
     profile?: {
         name: string;
         saveChanges?: boolean;
@@ -544,6 +545,8 @@ interface SearchRequest {
     location?: string;
     ignoreInvalidURLs?: boolean;
     timeout?: number;
+    /** Generate query-relevant highlights for search results. Defaults to true. */
+    highlights?: boolean;
     scrapeOptions?: ScrapeOptions;
     /**
      * Enterprise search options. Use `["zdr"]` for end-to-end Zero Data
@@ -633,6 +636,7 @@ interface MapOptions {
     origin?: string;
     location?: LocationConfig$1;
     threatProtection?: ThreatProtectionOptions;
+    auditMetadata?: Record<string, string>;
 }
 type FeedbackRating = "good" | "partial" | "bad";
 type EndpointFeedbackEndpoint = "search" | "scrape" | "parse" | "map";
@@ -1292,6 +1296,7 @@ declare function prepareAgentPayload(args: {
     model?: "spark-1-pro" | "spark-1-mini";
     webhook?: string | AgentWebhookConfig;
     threatProtection?: ThreatProtectionOptions;
+    auditMetadata?: Record<string, string>;
 }): Record<string, unknown>;
 declare function startAgent(http: HttpClient, args: Parameters<typeof prepareAgentPayload>[0]): Promise<AgentResponse>;
 
@@ -1855,6 +1860,7 @@ interface CrawlScrapeOptions {
     storeInCache?: boolean;
     maxAge?: number;
     parsePDF?: boolean;
+    auditMetadata?: Record<string, string>;
 }
 type Action = {
     type: "wait";
@@ -2020,6 +2026,7 @@ interface MapParams {
     timeout?: number;
     useIndex?: boolean;
     location?: LocationConfig;
+    auditMetadata?: Record<string, string>;
 }
 /**
  * Response interface for mapping operations.

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-OZ7DDARD.js";
+} from "./chunk-PSTSUWZW.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -584,6 +584,7 @@ function prepareSearchPayload(req) {
   if (req.ignoreInvalidURLs != null)
     payload.ignoreInvalidURLs = req.ignoreInvalidURLs;
   if (req.timeout != null) payload.timeout = req.timeout;
+  if (req.highlights != null) payload.highlights = req.highlights;
   if (req.integration && req.integration.trim())
     payload.integration = req.integration.trim();
   if (req.origin) payload.origin = req.origin;
@@ -668,6 +669,8 @@ function prepareMapPayload(url, options) {
     if (options.location != null) payload.location = options.location;
     if (options.threatProtection != null)
       payload.threatProtection = options.threatProtection;
+    if (options.auditMetadata != null)
+      payload.auditMetadata = options.auditMetadata;
   }
   return payload;
 }
@@ -1161,6 +1164,8 @@ function prepareAgentPayload(args) {
   if (args.webhook != null) body.webhook = args.webhook;
   if (args.threatProtection != null)
     body.threatProtection = args.threatProtection;
+  if (args.auditMetadata != null)
+    body.auditMetadata = args.auditMetadata;
   return body;
 }
 async function startAgent(http, args) {
@@ -2311,7 +2316,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-ZZWOLTXM.js");
+      const packageJson = await import("./package-Q3WPQZ6Q.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);

package/dist/{package-ZZWOLTXM.js → package-Q3WPQZ6Q.js}

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

package/package.json

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

package/src/__tests__/unit/v2/audit-metadata.unit.test.ts

@@ -0,0 +1,79 @@
+import { describe, test, expect, jest } from "@jest/globals";
+import { scrape } from "../../../v2/methods/scrape";
+import { startBatchScrape } from "../../../v2/methods/batch";
+import { startCrawl } from "../../../v2/methods/crawl";
+import { search } from "../../../v2/methods/search";
+import { map } from "../../../v2/methods/map";
+import { startExtract } from "../../../v2/methods/extract";
+import { startAgent } from "../../../v2/methods/agent";
+
+const auditMetadata = { requestId: "req-123" };
+
+function makeHttp(data: Record<string, unknown>) {
+  const post = jest.fn(async () => ({ status: 200, data }));
+  return {
+    post,
+    prepareHeaders: jest.fn(() => undefined),
+  } as any;
+}
+
+describe("v2 auditMetadata request serialization", () => {
+  test("scrape and batch scrape send metadata at the top level", async () => {
+    const scrapeHttp = makeHttp({ success: true, data: {} });
+    await scrape(scrapeHttp, "https://example.com", { auditMetadata });
+    expect(scrapeHttp.post.mock.calls[0][1]).toEqual(
+      expect.objectContaining({ auditMetadata }),
+    );
+
+    const batchHttp = makeHttp({ success: true, id: "job", url: "u" });
+    await startBatchScrape(batchHttp, ["https://example.com"], {
+      options: { auditMetadata },
+    });
+    expect(batchHttp.post.mock.calls[0][1]).toEqual(
+      expect.objectContaining({ auditMetadata }),
+    );
+  });
+
+  test("crawl, search, and extract send metadata under scrapeOptions", async () => {
+    const crawlHttp = makeHttp({ success: true, id: "job", url: "u" });
+    await startCrawl(crawlHttp, {
+      url: "https://example.com",
+      scrapeOptions: { auditMetadata },
+    });
+    expect(crawlHttp.post.mock.calls[0][1]).toEqual(
+      expect.objectContaining({ scrapeOptions: expect.objectContaining({ auditMetadata }) }),
+    );
+
+    const searchHttp = makeHttp({ success: true, data: {} });
+    await search(searchHttp, {
+      query: "example",
+      scrapeOptions: { auditMetadata },
+    });
+    expect(searchHttp.post.mock.calls[0][1]).toEqual(
+      expect.objectContaining({ scrapeOptions: expect.objectContaining({ auditMetadata }) }),
+    );
+
+    const extractHttp = makeHttp({ success: true, id: "job" });
+    await startExtract(extractHttp, {
+      urls: ["https://example.com"],
+      scrapeOptions: { auditMetadata },
+    });
+    expect(extractHttp.post.mock.calls[0][1]).toEqual(
+      expect.objectContaining({ scrapeOptions: expect.objectContaining({ auditMetadata }) }),
+    );
+  });
+
+  test("map and agent send metadata at the top level", async () => {
+    const mapHttp = makeHttp({ success: true, links: [] });
+    await map(mapHttp, "https://example.com", { auditMetadata });
+    expect(mapHttp.post.mock.calls[0][1]).toEqual(
+      expect.objectContaining({ auditMetadata }),
+    );
+
+    const agentHttp = makeHttp({ success: true, id: "job" });
+    await startAgent(agentHttp, { prompt: "find pricing", auditMetadata });
+    expect(agentHttp.post.mock.calls[0][1]).toEqual(
+      expect.objectContaining({ auditMetadata }),
+    );
+  });
+});

package/src/__tests__/unit/v2/search-highlights.unit.test.ts

@@ -0,0 +1,18 @@
+import { describe, expect, jest, test } from "@jest/globals";
+import { search } from "../../../v2/methods/search";
+
+describe("v2 search highlights", () => {
+  test("forwards the highlights option", async () => {
+    const http = {
+      post: jest.fn(async () => ({ status: 200, data: { success: true } })),
+    } as any;
+
+    await search(http, { query: "firecrawl", highlights: false });
+
+    expect(http.post).toHaveBeenCalledWith(
+      "/v2/search",
+      { query: "firecrawl", highlights: false },
+      {},
+    );
+  });
+});

package/src/v1/index.ts

@@ -135,6 +135,7 @@ export interface CrawlScrapeOptions {
   storeInCache?: boolean;
   maxAge?: number;
   parsePDF?: boolean;
+  auditMetadata?: Record<string, string>;
 }
 
 export type Action = {
@@ -310,6 +311,7 @@ export interface MapParams {
   timeout?: number;
   useIndex?: boolean;
   location?: LocationConfig;
+  auditMetadata?: Record<string, string>;
 }
 
 /**

package/src/v2/methods/agent.ts

@@ -15,6 +15,7 @@ function prepareAgentPayload(args: {
   model?: "spark-1-pro" | "spark-1-mini";
   webhook?: string | AgentWebhookConfig;
   threatProtection?: ThreatProtectionOptions;
+  auditMetadata?: Record<string, string>;
 }): Record<string, unknown> {
   const body: Record<string, unknown> = {};
   if (args.urls) body.urls = args.urls;
@@ -30,6 +31,8 @@ function prepareAgentPayload(args: {
   if (args.webhook != null) body.webhook = args.webhook;
   if (args.threatProtection != null)
     body.threatProtection = args.threatProtection;
+  if (args.auditMetadata != null)
+    body.auditMetadata = args.auditMetadata;
   return body;
 }
 

package/src/v2/methods/map.ts

@@ -26,6 +26,8 @@ function prepareMapPayload(
     if (options.location != null) payload.location = options.location;
     if (options.threatProtection != null)
       payload.threatProtection = options.threatProtection;
+    if (options.auditMetadata != null)
+      payload.auditMetadata = options.auditMetadata;
   }
   return payload;
 }

package/src/v2/methods/search.ts

@@ -37,6 +37,7 @@ function prepareSearchPayload(req: SearchRequest): Record<string, unknown> {
   if (req.ignoreInvalidURLs != null)
     payload.ignoreInvalidURLs = req.ignoreInvalidURLs;
   if (req.timeout != null) payload.timeout = req.timeout;
+  if (req.highlights != null) payload.highlights = req.highlights;
   if (req.integration && req.integration.trim())
     payload.integration = req.integration.trim();
   if (req.origin) payload.origin = req.origin;

package/src/v2/types.ts

@@ -209,6 +209,7 @@ export interface ScrapeOptions {
   lockdown?: boolean;
   redactPII?: boolean | RedactPIIOptions;
   threatProtection?: ThreatProtectionOptions;
+  auditMetadata?: Record<string, string>;
   profile?: {
     name: string;
     saveChanges?: boolean;
@@ -697,6 +698,8 @@ export interface SearchRequest {
   location?: string;
   ignoreInvalidURLs?: boolean;
   timeout?: number; // ms
+  /** Generate query-relevant highlights for search results. Defaults to true. */
+  highlights?: boolean;
   scrapeOptions?: ScrapeOptions;
   /**
    * Enterprise search options. Use `["zdr"]` for end-to-end Zero Data
@@ -794,6 +797,7 @@ export interface MapOptions {
   origin?: string;
   location?: LocationConfig;
   threatProtection?: ThreatProtectionOptions;
+  auditMetadata?: Record<string, string>;
 }
 
 export type FeedbackRating = "good" | "partial" | "bad";