@mendable/firecrawl-js 1.18.2 → 1.18.3-beta.1

package/dist/index.cjs

@@ -853,10 +853,12 @@ var FirecrawlApp = class {
   }
   /**
    * Initiates a deep research operation on a given topic and polls until completion.
+   * @param topic - The topic to research.
    * @param params - Parameters for the deep research operation.
+   * @param onActivity - Optional callback to receive activity updates in real-time.
    * @returns The final research results.
    */
-  async __deepResearch(topic, params) {
+  async __deepResearch(topic, params, onActivity) {
     try {
       const response = await this.__asyncDeepResearch(topic, params);
       if (!response.success || "error" in response) {
@@ -867,11 +869,19 @@ var FirecrawlApp = class {
       }
       const jobId = response.id;
       let researchStatus;
+      let lastActivityCount = 0;
       while (true) {
         researchStatus = await this.__checkDeepResearchStatus(jobId);
         if ("error" in researchStatus && !researchStatus.success) {
           return researchStatus;
         }
+        if (onActivity && researchStatus.activities) {
+          const newActivities = researchStatus.activities.slice(lastActivityCount);
+          for (const activity of newActivities) {
+            onActivity(activity);
+          }
+          lastActivityCount = researchStatus.activities.length;
+        }
         if (researchStatus.status === "completed") {
           return researchStatus;
         }

package/dist/index.d.cts

@@ -595,10 +595,18 @@ declare class FirecrawlApp {
     handleError(response: AxiosResponse, action: string): void;
     /**
      * Initiates a deep research operation on a given topic and polls until completion.
+     * @param topic - The topic to research.
      * @param params - Parameters for the deep research operation.
+     * @param onActivity - Optional callback to receive activity updates in real-time.
      * @returns The final research results.
      */
-    __deepResearch(topic: string, params: DeepResearchParams): Promise<DeepResearchStatusResponse | ErrorResponse>;
+    __deepResearch(topic: string, params: DeepResearchParams, onActivity?: (activity: {
+        type: string;
+        status: string;
+        message: string;
+        timestamp: string;
+        depth: number;
+    }) => void): Promise<DeepResearchStatusResponse | ErrorResponse>;
     /**
      * Initiates a deep research operation on a given topic without polling.
      * @param params - Parameters for the deep research operation.

package/dist/index.d.ts

@@ -595,10 +595,18 @@ declare class FirecrawlApp {
     handleError(response: AxiosResponse, action: string): void;
     /**
      * Initiates a deep research operation on a given topic and polls until completion.
+     * @param topic - The topic to research.
      * @param params - Parameters for the deep research operation.
+     * @param onActivity - Optional callback to receive activity updates in real-time.
      * @returns The final research results.
      */
-    __deepResearch(topic: string, params: DeepResearchParams): Promise<DeepResearchStatusResponse | ErrorResponse>;
+    __deepResearch(topic: string, params: DeepResearchParams, onActivity?: (activity: {
+        type: string;
+        status: string;
+        message: string;
+        timestamp: string;
+        depth: number;
+    }) => void): Promise<DeepResearchStatusResponse | ErrorResponse>;
     /**
      * Initiates a deep research operation on a given topic without polling.
      * @param params - Parameters for the deep research operation.

package/dist/index.js

@@ -817,10 +817,12 @@ var FirecrawlApp = class {
   }
   /**
    * Initiates a deep research operation on a given topic and polls until completion.
+   * @param topic - The topic to research.
    * @param params - Parameters for the deep research operation.
+   * @param onActivity - Optional callback to receive activity updates in real-time.
    * @returns The final research results.
    */
-  async __deepResearch(topic, params) {
+  async __deepResearch(topic, params, onActivity) {
     try {
       const response = await this.__asyncDeepResearch(topic, params);
       if (!response.success || "error" in response) {
@@ -831,11 +833,19 @@ var FirecrawlApp = class {
       }
       const jobId = response.id;
       let researchStatus;
+      let lastActivityCount = 0;
       while (true) {
         researchStatus = await this.__checkDeepResearchStatus(jobId);
         if ("error" in researchStatus && !researchStatus.success) {
           return researchStatus;
         }
+        if (onActivity && researchStatus.activities) {
+          const newActivities = researchStatus.activities.slice(lastActivityCount);
+          for (const activity of newActivities) {
+            onActivity(activity);
+          }
+          lastActivityCount = researchStatus.activities.length;
+        }
         if (researchStatus.status === "completed") {
           return researchStatus;
         }

package/package.json

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

package/src/index.ts

@@ -1391,10 +1391,22 @@ export default class FirecrawlApp {
 
   /**
    * Initiates a deep research operation on a given topic and polls until completion.
+   * @param topic - The topic to research.
    * @param params - Parameters for the deep research operation.
+   * @param onActivity - Optional callback to receive activity updates in real-time.
    * @returns The final research results.
    */
-  async __deepResearch(topic: string, params: DeepResearchParams): Promise<DeepResearchStatusResponse | ErrorResponse> {
+  async __deepResearch(
+    topic: string, 
+    params: DeepResearchParams,
+    onActivity?: (activity: {
+      type: string;
+      status: string;
+      message: string;
+      timestamp: string;
+      depth: number;
+    }) => void
+  ): Promise<DeepResearchStatusResponse | ErrorResponse> {
     try {
       const response = await this.__asyncDeepResearch(topic, params);
       
@@ -1408,16 +1420,24 @@ export default class FirecrawlApp {
 
       const jobId = response.id;
       let researchStatus;
+      let lastActivityCount = 0;
 
       while (true) {
-        // console.log("Checking research status...");
         researchStatus = await this.__checkDeepResearchStatus(jobId);
-        // console.log("Research status:", researchStatus);
         
         if ('error' in researchStatus && !researchStatus.success) {
           return researchStatus;
         }
 
+        // Stream new activities through the callback if provided
+        if (onActivity && researchStatus.activities) {
+          const newActivities = researchStatus.activities.slice(lastActivityCount);
+          for (const activity of newActivities) {
+            onActivity(activity);
+          }
+          lastActivityCount = researchStatus.activities.length;
+        }
+
         if (researchStatus.status === "completed") {
           return researchStatus;
         }
@@ -1435,7 +1455,6 @@ export default class FirecrawlApp {
 
         await new Promise(resolve => setTimeout(resolve, 2000));
       }
-      // console.log("Research status finished:", researchStatus);
 
       return { success: false, error: "Research job terminated unexpectedly" };
     } catch (error: any) {