@mendable/firecrawl-js 4.31.1 → 4.32.0

package/dist/{chunk-BEF2NAMB.js → chunk-DBXKWZGC.js}

@@ -12,7 +12,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@mendable/firecrawl-js",
-      version: "4.31.1",
+      version: "4.32.0",
       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.31.1",
+      version: "4.32.0",
       description: "JavaScript SDK for Firecrawl API",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -746,12 +746,16 @@ async function search(http, request) {
     if (data.news) out.news = transformArray(data.news);
     if (data.images)
       out.images = transformArray(data.images);
+    if (data.developer)
+      out.developer = transformArray(data.developer);
     Object.defineProperty(out, "data", {
       get() {
         const parts = [];
         if (out.web?.length) parts.push(`.web (${out.web.length} results)`);
         if (out.news?.length) parts.push(`.news (${out.news.length} results)`);
         if (out.images?.length) parts.push(`.images (${out.images.length} results)`);
+        if (out.developer?.length)
+          parts.push(`.developer (${out.developer.length} results)`);
         const available = parts.length ? parts.join(", ") : ".web, .news, or .images";
         throw new Error(
           `SearchData has no '.data'. Results are grouped by source: ${available}`

package/dist/index.d.cts

@@ -508,6 +508,7 @@ interface SearchResultWeb {
     url: string;
     title?: string;
     description?: string;
+    position?: number;
     category?: string;
 }
 interface SearchResultNews {
@@ -531,16 +532,17 @@ interface SearchData {
     web?: Array<SearchResultWeb | Document>;
     news?: Array<SearchResultNews | Document>;
     images?: Array<SearchResultImages | Document>;
+    developer?: Array<SearchResultWeb | Document>;
 }
 interface CategoryOption {
-    type: "github" | "research" | "pdf";
+    type: "github" | "research" | "pdf" | "developer";
 }
 interface SearchRequest {
     query: string;
     sources?: Array<"web" | "news" | "images" | {
         type: "web" | "news" | "images";
     }>;
-    categories?: Array<"github" | "research" | "pdf" | CategoryOption>;
+    categories?: Array<"github" | "research" | "pdf" | "developer" | CategoryOption>;
     includeDomains?: string[];
     excludeDomains?: string[];
     limit?: number;

package/dist/index.d.ts

@@ -508,6 +508,7 @@ interface SearchResultWeb {
     url: string;
     title?: string;
     description?: string;
+    position?: number;
     category?: string;
 }
 interface SearchResultNews {
@@ -531,16 +532,17 @@ interface SearchData {
     web?: Array<SearchResultWeb | Document>;
     news?: Array<SearchResultNews | Document>;
     images?: Array<SearchResultImages | Document>;
+    developer?: Array<SearchResultWeb | Document>;
 }
 interface CategoryOption {
-    type: "github" | "research" | "pdf";
+    type: "github" | "research" | "pdf" | "developer";
 }
 interface SearchRequest {
     query: string;
     sources?: Array<"web" | "news" | "images" | {
         type: "web" | "news" | "images";
     }>;
-    categories?: Array<"github" | "research" | "pdf" | CategoryOption>;
+    categories?: Array<"github" | "research" | "pdf" | "developer" | CategoryOption>;
     includeDomains?: string[];
     excludeDomains?: string[];
     limit?: number;

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   require_package
-} from "./chunk-BEF2NAMB.js";
+} from "./chunk-DBXKWZGC.js";
 
 // src/v2/utils/httpClient.ts
 import axios from "axios";
@@ -629,12 +629,16 @@ async function search(http, request) {
     if (data.news) out.news = transformArray(data.news);
     if (data.images)
       out.images = transformArray(data.images);
+    if (data.developer)
+      out.developer = transformArray(data.developer);
     Object.defineProperty(out, "data", {
       get() {
         const parts = [];
         if (out.web?.length) parts.push(`.web (${out.web.length} results)`);
         if (out.news?.length) parts.push(`.news (${out.news.length} results)`);
         if (out.images?.length) parts.push(`.images (${out.images.length} results)`);
+        if (out.developer?.length)
+          parts.push(`.developer (${out.developer.length} results)`);
         const available = parts.length ? parts.join(", ") : ".web, .news, or .images";
         throw new Error(
           `SearchData has no '.data'. Results are grouped by source: ${available}`
@@ -2316,7 +2320,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-GIVYQAT4.js");
+      const packageJson = await import("./package-L37ZVTF4.js");
       return packageJson.default.version;
     } catch (error) {
       const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);

package/dist/{package-GIVYQAT4.js → package-L37ZVTF4.js}

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

package/package.json

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

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

@@ -0,0 +1,65 @@
+import { describe, expect, jest, test } from "@jest/globals";
+import { search } from "../../../v2/methods/search";
+
+const developerResult = {
+  title: "https://github.com/firecrawl/firecrawl/issues/1",
+  url: "https://github.com/firecrawl/firecrawl/issues/1",
+  description: "passage",
+  position: 1,
+  category: "developer",
+};
+
+function httpWith(data: Record<string, unknown>) {
+  return {
+    post: jest.fn(async () => ({ status: 200, data: { success: true, data } })),
+  } as any;
+}
+
+describe("v2 search developer category", () => {
+  test("forwards the developer category", async () => {
+    const http = httpWith({});
+
+    await search(http, { query: "firecrawl", categories: ["developer"] });
+
+    expect(http.post).toHaveBeenCalledWith(
+      "/v2/search",
+      { query: "firecrawl", categories: ["developer"] },
+      {},
+    );
+  });
+
+  test("returns developer results", async () => {
+    const http = httpWith({
+      web: [{ title: "W", url: "http://a.com" }],
+      developer: [developerResult],
+    });
+
+    const result = await search(http, {
+      query: "firecrawl",
+      categories: [{ type: "developer" }],
+    });
+
+    expect(result.web).toHaveLength(1);
+    expect(result.developer).toHaveLength(1);
+    expect(result.developer?.[0]).toEqual(developerResult);
+  });
+
+  test("omits developer when the response has none", async () => {
+    const http = httpWith({ web: [] });
+
+    const result = await search(http, { query: "firecrawl" });
+
+    expect(result.developer).toBeUndefined();
+  });
+
+  test("lists developer in the .data error", async () => {
+    const http = httpWith({ developer: [developerResult] });
+
+    const result = await search(http, {
+      query: "firecrawl",
+      categories: ["developer"],
+    });
+
+    expect(() => (result as any).data).toThrow(/\.developer \(1 results\)/);
+  });
+});

package/src/v2/methods/search.ts

@@ -102,12 +102,16 @@ export async function search(
     if (data.news) out.news = transformArray<SearchResultNews>(data.news);
     if (data.images)
       out.images = transformArray<SearchResultImages>(data.images);
+    if (data.developer)
+      out.developer = transformArray<SearchResultWeb>(data.developer);
     Object.defineProperty(out, "data", {
       get() {
         const parts: string[] = [];
         if (out.web?.length) parts.push(`.web (${out.web.length} results)`);
         if (out.news?.length) parts.push(`.news (${out.news.length} results)`);
         if (out.images?.length) parts.push(`.images (${out.images.length} results)`);
+        if (out.developer?.length)
+          parts.push(`.developer (${out.developer.length} results)`);
         const available = parts.length ? parts.join(", ") : ".web, .news, or .images";
         throw new Error(
           `SearchData has no '.data'. Results are grouped by source: ${available}`,

package/src/v2/types.ts

@@ -657,6 +657,7 @@ export interface SearchResultWeb {
   url: string;
   title?: string;
   description?: string;
+  position?: number;
   category?: string;
 }
 
@@ -683,10 +684,11 @@ export interface SearchData {
   web?: Array<SearchResultWeb | Document>;
   news?: Array<SearchResultNews | Document>;
   images?: Array<SearchResultImages | Document>;
+  developer?: Array<SearchResultWeb | Document>;
 }
 
 export interface CategoryOption {
-  type: "github" | "research" | "pdf";
+  type: "github" | "research" | "pdf" | "developer";
 }
 
 export interface SearchRequest {
@@ -694,7 +696,9 @@ export interface SearchRequest {
   sources?: Array<
     "web" | "news" | "images" | { type: "web" | "news" | "images" }
   >;
-  categories?: Array<"github" | "research" | "pdf" | CategoryOption>;
+  categories?: Array<
+    "github" | "research" | "pdf" | "developer" | CategoryOption
+  >;
   includeDomains?: string[];
   excludeDomains?: string[];
   limit?: number;