@mendable/firecrawl-js 4.50.0 → 4.50.1

package/dist/{chunk-NXSNF7F3.js → chunk-UGAMW2BL.js}

@@ -1,6 +1,6 @@
 // package.json
 var name = "@mendable/firecrawl-js";
-var version = "4.50.0";
+var version = "4.50.1";
 var description = "JavaScript SDK for Firecrawl, the context API for AI agents: search, scrape, parse, crawl, map, and interact with the web, run Agent and Monitor jobs, and search scientific papers (PubMed, bioRxiv, medRxiv, arXiv)";
 var main = "dist/index.js";
 var types = "dist/index.d.ts";
@@ -44,7 +44,7 @@ var devDependencies = {
   tsup: "^8.5.0",
   typescript: "^5.4.5",
   uuid: "^14.0.0",
-  vitest: "^4.1.11"
+  vitest: "^4.1.12"
 };
 var keywords = [
   "firecrawl",

package/dist/index.cjs

@@ -39,7 +39,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.50.0",
+      version: "4.50.1",
       description: "JavaScript SDK for Firecrawl, the context API for AI agents: search, scrape, parse, crawl, map, and interact with the web, run Agent and Monitor jobs, and search scientific papers (PubMed, bioRxiv, medRxiv, arXiv)",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -83,7 +83,7 @@ var require_package = __commonJS({
         tsup: "^8.5.0",
         typescript: "^5.4.5",
         uuid: "^14.0.0",
-        vitest: "^4.1.11"
+        vitest: "^4.1.12"
       },
       keywords: [
         "firecrawl",
@@ -1674,6 +1674,8 @@ function prepareAgentPayload(args) {
   if (args.threadId != null) body.threadId = args.threadId;
   if (args.mode != null) body.mode = args.mode;
   if (args.exchange != null) body.exchange = args.exchange;
+  if (args.location != null) body.location = args.location;
+  if (args.zeroDataRetention != null) body.zeroDataRetention = args.zeroDataRetention;
   return body;
 }
 async function startAgent(http, args) {

package/dist/index.d.cts

@@ -1552,7 +1552,7 @@ interface AgentTraceAgentIdentity {
     parentId?: string;
 }
 interface AgentTraceError {
-    code: "cancelled" | "credit_limit_reached" | "parent_finished" | "refused" | "internal";
+    code: "cancelled" | "credit_limit_reached" | "insufficient_credits" | "parent_finished" | "refused" | "internal";
     source: "agent" | "tool" | "billing" | "system";
     retryable: boolean;
     message: string;
@@ -1658,6 +1658,8 @@ interface AgentTraceResponse {
     creditsUsed?: number;
     /** Present only when the trace was requested with liveView: true. */
     activeBrowserSessions?: AgentTraceActiveBrowserSession[];
+    /** True for a zero data retention run: events are limited to content-free lifecycle events. */
+    zeroDataRetention?: boolean;
     error?: string;
 }
 interface AgentSnapshotResponse {
@@ -2109,6 +2111,14 @@ declare function prepareAgentPayload(args: {
     threadId?: string;
     mode?: AgentMode;
     exchange?: AgentExchangeOptions;
+    /**
+     * Country for the whole run (ISO 3166-1 alpha-2). Scrapes and browser sessions are proxied from it,
+     * and search results are localized to it without changing where requests come from. The agent cannot change it.
+     */
+    location?: {
+        country: string;
+    };
+    zeroDataRetention?: boolean;
 }): Record<string, unknown>;
 declare function startAgent(http: HttpClient, args: Parameters<typeof prepareAgentPayload>[0]): Promise<AgentResponse>;
 

package/dist/index.d.ts

@@ -1552,7 +1552,7 @@ interface AgentTraceAgentIdentity {
     parentId?: string;
 }
 interface AgentTraceError {
-    code: "cancelled" | "credit_limit_reached" | "parent_finished" | "refused" | "internal";
+    code: "cancelled" | "credit_limit_reached" | "insufficient_credits" | "parent_finished" | "refused" | "internal";
     source: "agent" | "tool" | "billing" | "system";
     retryable: boolean;
     message: string;
@@ -1658,6 +1658,8 @@ interface AgentTraceResponse {
     creditsUsed?: number;
     /** Present only when the trace was requested with liveView: true. */
     activeBrowserSessions?: AgentTraceActiveBrowserSession[];
+    /** True for a zero data retention run: events are limited to content-free lifecycle events. */
+    zeroDataRetention?: boolean;
     error?: string;
 }
 interface AgentSnapshotResponse {
@@ -2109,6 +2111,14 @@ declare function prepareAgentPayload(args: {
     threadId?: string;
     mode?: AgentMode;
     exchange?: AgentExchangeOptions;
+    /**
+     * Country for the whole run (ISO 3166-1 alpha-2). Scrapes and browser sessions are proxied from it,
+     * and search results are localized to it without changing where requests come from. The agent cannot change it.
+     */
+    location?: {
+        country: string;
+    };
+    zeroDataRetention?: boolean;
 }): Record<string, unknown>;
 declare function startAgent(http: HttpClient, args: Parameters<typeof prepareAgentPayload>[0]): Promise<AgentResponse>;
 

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   version
-} from "./chunk-NXSNF7F3.js";
+} from "./chunk-UGAMW2BL.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -1545,6 +1545,8 @@ function prepareAgentPayload(args) {
   if (args.threadId != null) body.threadId = args.threadId;
   if (args.mode != null) body.mode = args.mode;
   if (args.exchange != null) body.exchange = args.exchange;
+  if (args.location != null) body.location = args.location;
+  if (args.zeroDataRetention != null) body.zeroDataRetention = args.zeroDataRetention;
   return body;
 }
 async function startAgent(http, args) {
@@ -2999,7 +3001,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-KFOQKI5Z.js");
+      const packageJson = await import("./package-TFTOUFDX.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && !!process.env && false;

package/dist/{package-KFOQKI5Z.js → package-TFTOUFDX.js}

@@ -17,7 +17,7 @@ import {
   type,
   types,
   version
-} from "./chunk-NXSNF7F3.js";
+} from "./chunk-UGAMW2BL.js";
 export {
   author,
   bugs,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mendable/firecrawl-js",
-  "version": "4.50.0",
+  "version": "4.50.1",
   "description": "JavaScript SDK for Firecrawl, the context API for AI agents: search, scrape, parse, crawl, map, and interact with the web, run Agent and Monitor jobs, and search scientific papers (PubMed, bioRxiv, medRxiv, arXiv)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,7 +20,7 @@
   "license": "MIT",
   "dependencies": {
     "axios": "1.20.0",
-    "firecrawl": "4.50.0",
+    "firecrawl": "4.50.1",
     "typescript-event-target": "^1.1.1",
     "zod": "^3.23.8",
     "zod-to-json-schema": "^3.23.0"
@@ -37,7 +37,7 @@
     "tsup": "^8.5.0",
     "typescript": "^5.4.5",
     "uuid": "^14.0.0",
-    "vitest": "^4.1.11"
+    "vitest": "^4.1.12"
   },
   "keywords": [
     "firecrawl",

package/pnpm-workspace.yaml

@@ -14,6 +14,8 @@ overrides:
   # GHSA-m8m8-qj5v-23w3 / GHSA-44g4-m2mj-wpvx / GHSA-r4gj-5m52-g5wh:
   # pin the 1.x line only. Exact 1.20.0 cannot resolve to 2.x.
   "axios@>=1.0.0 <1.20.0": "1.20.0"
-  "follow-redirects@<1.16.0": ">=1.16.0 <2.0.0"
+  # GHSA-Q3JH-WRC6-JGQ8 / GHSA-8R9P-F939-6H3C: fixed in 1.16.1.
+  # Replacement is bounded <2.0.0; cannot resolve to follow-redirects 2.x.
+  "follow-redirects@<1.16.1": ">=1.16.1 <2.0.0"
   "form-data@>=4.0.0 <4.0.6": "4.0.6"
   "esbuild@>=0.17.0 <0.28.1": "0.28.1"

package/src/__tests__/unit/v2/agent-location.unit.test.ts

@@ -0,0 +1,34 @@
+import { describe, test, expect, vi } from "vitest";
+import { startAgent } from "../../../v2/methods/agent";
+
+describe("JS SDK v2 agent location", () => {
+  const post = () =>
+    vi.fn(async () => ({
+      status: 200,
+      data: { success: true, id: "agent-1" },
+    }));
+
+  test("sends location when starting an agent", async () => {
+    const http = { post: post() };
+
+    await startAgent(http as any, {
+      prompt: "Find the pricing page",
+      location: { country: "DE" },
+    });
+
+    expect(http.post).toHaveBeenCalledWith("/v2/agent", {
+      prompt: "Find the pricing page",
+      location: { country: "DE" },
+    });
+  });
+
+  test("omits location by default", async () => {
+    const http = { post: post() };
+
+    await startAgent(http as any, { prompt: "Find the pricing page" });
+
+    expect(http.post).toHaveBeenCalledWith("/v2/agent", {
+      prompt: "Find the pricing page",
+    });
+  });
+});

package/src/v2/methods/agent.ts

@@ -21,6 +21,12 @@ function prepareAgentPayload(args: {
   threadId?: string;
   mode?: AgentMode;
   exchange?: AgentExchangeOptions;
+  /**
+   * Country for the whole run (ISO 3166-1 alpha-2). Scrapes and browser sessions are proxied from it,
+   * and search results are localized to it without changing where requests come from. The agent cannot change it.
+   */
+  location?: { country: string };
+  zeroDataRetention?: boolean;
 }): Record<string, unknown> {
   const body: Record<string, unknown> = {};
   if (args.urls) body.urls = args.urls;
@@ -42,6 +48,8 @@ function prepareAgentPayload(args: {
   if (args.threadId != null) body.threadId = args.threadId;
   if (args.mode != null) body.mode = args.mode;
   if (args.exchange != null) body.exchange = args.exchange;
+  if (args.location != null) body.location = args.location;
+  if (args.zeroDataRetention != null) body.zeroDataRetention = args.zeroDataRetention;
   return body;
 }
 

package/src/v2/types.ts

@@ -300,7 +300,12 @@ export interface ScrapeOptions {
 }
 
 export type RedactPIIEntity =
-  "PERSON" | "EMAIL" | "PHONE" | "LOCATION" | "FINANCIAL" | "SECRET";
+  | "PERSON"
+  | "EMAIL"
+  | "PHONE"
+  | "LOCATION"
+  | "FINANCIAL"
+  | "SECRET";
 
 export interface RedactPIIOptions {
   /**
@@ -347,7 +352,12 @@ export interface ThreatProtectionOptions {
 }
 
 export type ParseFileData =
-  Blob | File | Buffer | Uint8Array | ArrayBuffer | string;
+  | Blob
+  | File
+  | Buffer
+  | Uint8Array
+  | ArrayBuffer
+  | string;
 
 export interface ParseFile {
   data: ParseFileData;
@@ -395,7 +405,11 @@ export interface WebhookConfig {
 
 // Agent webhook events differ from crawl: has 'action' and 'cancelled', no 'page'
 export type AgentWebhookEvent =
-  "started" | "action" | "completed" | "failed" | "cancelled";
+  | "started"
+  | "action"
+  | "completed"
+  | "failed"
+  | "cancelled";
 
 export interface AgentWebhookConfig {
   url: string;
@@ -516,7 +530,10 @@ export interface BrandingProfile {
     headerHeight?: string;
     footerHeight?: string;
     [key: string]:
-      number | string | Record<string, number | string | undefined> | undefined;
+      | number
+      | string
+      | Record<string, number | string | undefined>
+      | undefined;
   };
   tone?: {
     voice?: string;
@@ -1014,7 +1031,10 @@ export interface SearchRequest {
   /** Compact by default; summary adds metadata, full includes contracts. */
   toolDetail?: "compact" | "summary" | "full";
   sources?: Array<
-    "web" | "news" | "images" | "alexandria"
+    | "web"
+    | "news"
+    | "images"
+    | "alexandria"
     | { type: "web" | "news" | "images" | "alexandria" }
   >;
   /**
@@ -1265,7 +1285,9 @@ export interface MonitorSearchTarget {
 }
 
 export type MonitorTarget =
-  MonitorScrapeTarget | MonitorCrawlTarget | MonitorSearchTarget;
+  | MonitorScrapeTarget
+  | MonitorCrawlTarget
+  | MonitorSearchTarget;
 
 export interface CreateMonitorRequest {
   name: string;
@@ -1388,7 +1410,11 @@ export interface MonitorCheck {
   reservedCredits?: number | null;
   actualCredits?: number | null;
   billingStatus:
-    "not_applicable" | "reserved" | "confirmed" | "released" | "failed";
+    | "not_applicable"
+    | "reserved"
+    | "confirmed"
+    | "released"
+    | "failed";
   summary: MonitorSummary;
   targetResults?: MonitorTargetResult[];
   notificationStatus?: unknown;
@@ -1779,7 +1805,10 @@ export interface AgentListOptions {
 }
 
 export type AgentTraceAgentRole =
-  "orchestrator" | "subagent" | "browser" | "system";
+  | "orchestrator"
+  | "subagent"
+  | "browser"
+  | "system";
 
 export interface AgentTraceAgentIdentity {
   id: string;
@@ -1792,6 +1821,7 @@ export interface AgentTraceError {
   code:
     | "cancelled"
     | "credit_limit_reached"
+    | "insufficient_credits"
     | "parent_finished"
     | "refused"
     | "internal";
@@ -1833,7 +1863,11 @@ export interface AgentTraceRunCancelRequestedEvent extends AgentTraceEventBase {
 export interface AgentTraceRunFinishedEvent extends AgentTraceEventBase {
   type: "run.finished";
   outcome:
-    "succeeded" | "failed" | "cancelled" | "refused" | "credit_limit_reached";
+    | "succeeded"
+    | "failed"
+    | "cancelled"
+    | "refused"
+    | "credit_limit_reached";
   /** The canonical schema always writes this key (nullable), but older rows may omit it. */
   error?: AgentTraceError | null;
 }
@@ -1850,12 +1884,14 @@ export interface AgentTraceAgentFinishedEvent extends AgentTraceEventBase {
   error?: AgentTraceError | null;
 }
 
-export interface AgentTraceBrowserSessionStartedEvent extends AgentTraceEventBase {
+export interface AgentTraceBrowserSessionStartedEvent
+  extends AgentTraceEventBase {
   type: "browser.session.started";
   sessionId: string;
 }
 
-export interface AgentTraceBrowserSessionFinishedEvent extends AgentTraceEventBase {
+export interface AgentTraceBrowserSessionFinishedEvent
+  extends AgentTraceEventBase {
   type: "browser.session.finished";
   sessionId: string;
   durationMs: number;
@@ -1929,6 +1965,8 @@ export interface AgentTraceResponse {
   creditsUsed?: number;
   /** Present only when the trace was requested with liveView: true. */
   activeBrowserSessions?: AgentTraceActiveBrowserSession[];
+  /** True for a zero data retention run: events are limited to content-free lifecycle events. */
+  zeroDataRetention?: boolean;
   error?: string;
 }
 
@@ -2028,7 +2066,9 @@ export interface RequiresAction {
   url?: string;
 }
 
-export function parseRequiresAction(value: unknown): RequiresAction | undefined {
+export function parseRequiresAction(
+  value: unknown,
+): RequiresAction | undefined {
   if (!value || typeof value !== "object") return undefined;
   const record = value as Record<string, unknown>;
   if (typeof record.type !== "string") return undefined;