@mendable/firecrawl-js 1.18.0-beta.1 → 1.18.0-beta.2

package/dist/index.cjs

@@ -852,11 +852,43 @@ var FirecrawlApp = class {
     }
   }
   /**
-   * Initiates a deep research operation on a given topic.
+   * Initiates a deep research operation on a given topic and polls until completion.
    * @param params - Parameters for the deep research operation.
-   * @returns The response containing the research job ID.
+   * @returns The final research results.
    */
   async __deepResearch(params) {
+    try {
+      const response = await this.__asyncDeepResearch(params);
+      if (!response.success || "error" in response) {
+        return { success: false, error: "error" in response ? response.error : "Unknown error" };
+      }
+      if (response.id) {
+        const jobId = response.id;
+        let researchStatus;
+        do {
+          researchStatus = await this.__checkDeepResearchStatus(jobId);
+          if ("error" in researchStatus && !researchStatus.success) {
+            return researchStatus;
+          }
+          if (researchStatus.status === "completed") {
+            return researchStatus;
+          } else if (researchStatus.status === "failed") {
+            throw new FirecrawlError(`Research job failed. Error: ${researchStatus.error}`, 500);
+          }
+          await new Promise((resolve) => setTimeout(resolve, 1e3));
+        } while (researchStatus.status === "processing");
+      }
+      throw new FirecrawlError(`Failed to start research. No job ID returned.`, 500);
+    } catch (error) {
+      throw new FirecrawlError(error.message, 500, error.response?.data?.details);
+    }
+  }
+  /**
+   * Initiates a deep research operation on a given topic without polling.
+   * @param params - Parameters for the deep research operation.
+   * @returns The response containing the research job ID.
+   */
+  async __asyncDeepResearch(params) {
     const headers = this.prepareHeaders();
     try {
       const response = await this.postRequest(

package/dist/index.d.cts

@@ -557,11 +557,17 @@ declare class FirecrawlApp {
      */
     handleError(response: AxiosResponse, action: string): void;
     /**
-     * Initiates a deep research operation on a given topic.
+     * Initiates a deep research operation on a given topic and polls until completion.
+     * @param params - Parameters for the deep research operation.
+     * @returns The final research results.
+     */
+    __deepResearch(params: DeepResearchParams): Promise<DeepResearchStatusResponse | ErrorResponse>;
+    /**
+     * Initiates a deep research operation on a given topic without polling.
      * @param params - Parameters for the deep research operation.
      * @returns The response containing the research job ID.
      */
-    __deepResearch(params: DeepResearchParams): Promise<DeepResearchResponse | ErrorResponse>;
+    __asyncDeepResearch(params: DeepResearchParams): Promise<DeepResearchResponse | ErrorResponse>;
     /**
      * Checks the status of a deep research operation.
      * @param id - The ID of the deep research operation.

package/dist/index.d.ts

@@ -557,11 +557,17 @@ declare class FirecrawlApp {
      */
     handleError(response: AxiosResponse, action: string): void;
     /**
-     * Initiates a deep research operation on a given topic.
+     * Initiates a deep research operation on a given topic and polls until completion.
+     * @param params - Parameters for the deep research operation.
+     * @returns The final research results.
+     */
+    __deepResearch(params: DeepResearchParams): Promise<DeepResearchStatusResponse | ErrorResponse>;
+    /**
+     * Initiates a deep research operation on a given topic without polling.
      * @param params - Parameters for the deep research operation.
      * @returns The response containing the research job ID.
      */
-    __deepResearch(params: DeepResearchParams): Promise<DeepResearchResponse | ErrorResponse>;
+    __asyncDeepResearch(params: DeepResearchParams): Promise<DeepResearchResponse | ErrorResponse>;
     /**
      * Checks the status of a deep research operation.
      * @param id - The ID of the deep research operation.

package/dist/index.js

@@ -816,11 +816,43 @@ var FirecrawlApp = class {
     }
   }
   /**
-   * Initiates a deep research operation on a given topic.
+   * Initiates a deep research operation on a given topic and polls until completion.
    * @param params - Parameters for the deep research operation.
-   * @returns The response containing the research job ID.
+   * @returns The final research results.
    */
   async __deepResearch(params) {
+    try {
+      const response = await this.__asyncDeepResearch(params);
+      if (!response.success || "error" in response) {
+        return { success: false, error: "error" in response ? response.error : "Unknown error" };
+      }
+      if (response.id) {
+        const jobId = response.id;
+        let researchStatus;
+        do {
+          researchStatus = await this.__checkDeepResearchStatus(jobId);
+          if ("error" in researchStatus && !researchStatus.success) {
+            return researchStatus;
+          }
+          if (researchStatus.status === "completed") {
+            return researchStatus;
+          } else if (researchStatus.status === "failed") {
+            throw new FirecrawlError(`Research job failed. Error: ${researchStatus.error}`, 500);
+          }
+          await new Promise((resolve) => setTimeout(resolve, 1e3));
+        } while (researchStatus.status === "processing");
+      }
+      throw new FirecrawlError(`Failed to start research. No job ID returned.`, 500);
+    } catch (error) {
+      throw new FirecrawlError(error.message, 500, error.response?.data?.details);
+    }
+  }
+  /**
+   * Initiates a deep research operation on a given topic without polling.
+   * @param params - Parameters for the deep research operation.
+   * @returns The response containing the research job ID.
+   */
+  async __asyncDeepResearch(params) {
     const headers = this.prepareHeaders();
     try {
       const response = await this.postRequest(

package/package.json

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

package/src/index.ts

@@ -1350,11 +1350,48 @@ export default class FirecrawlApp {
   }
 
   /**
-   * Initiates a deep research operation on a given topic.
+   * Initiates a deep research operation on a given topic and polls until completion.
+   * @param params - Parameters for the deep research operation.
+   * @returns The final research results.
+   */
+  async __deepResearch(params: DeepResearchParams): Promise<DeepResearchStatusResponse | ErrorResponse> {
+    try {
+      const response = await this.__asyncDeepResearch(params);
+      
+      if (!response.success || 'error' in response) {
+        return { success: false, error: 'error' in response ? response.error : 'Unknown error' };
+      }
+
+      if (response.id) {
+        const jobId = response.id;
+        let researchStatus;
+        do {
+          researchStatus = await this.__checkDeepResearchStatus(jobId);
+          
+          if ('error' in researchStatus && !researchStatus.success) {
+            return researchStatus;
+          }
+
+          if (researchStatus.status === "completed") {
+            return researchStatus;
+          } else if (researchStatus.status === "failed") {
+            throw new FirecrawlError(`Research job failed. Error: ${researchStatus.error}`, 500);
+          }
+          await new Promise(resolve => setTimeout(resolve, 1000)); // Polling interval
+        } while (researchStatus.status === "processing");
+      }
+      throw new FirecrawlError(`Failed to start research. No job ID returned.`, 500);
+    } catch (error: any) {
+      throw new FirecrawlError(error.message, 500, error.response?.data?.details);
+    }
+  }
+
+  /**
+   * Initiates a deep research operation on a given topic without polling.
    * @param params - Parameters for the deep research operation.
    * @returns The response containing the research job ID.
    */
-  async __deepResearch(params: DeepResearchParams): Promise<DeepResearchResponse | ErrorResponse> {
+  async __asyncDeepResearch(params: DeepResearchParams): Promise<DeepResearchResponse | ErrorResponse> {
     const headers = this.prepareHeaders();
     try {
       const response: AxiosResponse = await this.postRequest(