@mendable/firecrawl-js 4.30.0 → 4.30.1

package/dist/{chunk-OZ7DDARD.js → chunk-2LUWTM44.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.30.1",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",

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.30.1",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -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;

package/dist/index.d.cts

@@ -544,6 +544,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

package/dist/index.d.ts

@@ -544,6 +544,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

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-OZ7DDARD.js";
+} from "./chunk-2LUWTM44.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;
@@ -2311,7 +2312,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-2VNCXFNY.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-2VNCXFNY.js}

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

package/package.json

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

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/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

@@ -697,6 +697,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