firecrawl 1.3.0 → 1.4.2

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { AxiosRequestHeaders, AxiosResponse } from 'axios';
-import { ZodSchema } from 'zod';
+import * as zt from 'zod';
 import { TypedEventTarget } from 'typescript-event-target';
 
 /**
@@ -54,13 +54,13 @@ interface FirecrawlDocumentMetadata {
  * Document interface for Firecrawl.
  * Represents a document retrieved or processed by Firecrawl.
  */
-interface FirecrawlDocument {
+interface FirecrawlDocument<T> {
     url?: string;
     markdown?: string;
     html?: string;
     rawHtml?: string;
     links?: string[];
-    extract?: Record<any, any>;
+    extract?: T;
     screenshot?: string;
     metadata?: FirecrawlDocumentMetadata;
 }
@@ -68,25 +68,27 @@ interface FirecrawlDocument {
  * Parameters for scraping operations.
  * Defines the options and configurations available for scraping web content.
  */
-interface ScrapeParams {
+interface CrawlScrapeOptions {
     formats: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "extract" | "full@scrennshot")[];
     headers?: Record<string, string>;
     includeTags?: string[];
     excludeTags?: string[];
     onlyMainContent?: boolean;
+    waitFor?: number;
+    timeout?: number;
+}
+interface ScrapeParams<LLMSchema extends zt.ZodSchema> extends CrawlScrapeOptions {
     extract?: {
         prompt?: string;
-        schema?: ZodSchema | any;
+        schema?: LLMSchema;
         systemPrompt?: string;
     };
-    waitFor?: number;
-    timeout?: number;
 }
 /**
  * Response interface for scraping operations.
  * Defines the structure of the response received after a scraping operation.
  */
-interface ScrapeResponse extends FirecrawlDocument {
+interface ScrapeResponse<LLMResult> extends FirecrawlDocument<LLMResult> {
     success: true;
     warning?: string;
     error?: string;
@@ -103,7 +105,7 @@ interface CrawlParams {
     allowBackwardLinks?: boolean;
     allowExternalLinks?: boolean;
     ignoreSitemap?: boolean;
-    scrapeOptions?: ScrapeParams;
+    scrapeOptions?: CrawlScrapeOptions;
     webhook?: string;
 }
 /**
@@ -128,7 +130,7 @@ interface CrawlStatusResponse {
     creditsUsed: number;
     expiresAt: Date;
     next?: string;
-    data: FirecrawlDocument[];
+    data: FirecrawlDocument<undefined>[];
 }
 /**
  * Parameters for mapping operations.
@@ -175,7 +177,7 @@ declare class FirecrawlApp {
      * @param params - Additional parameters for the scrape request.
      * @returns The response from the scrape operation.
      */
-    scrapeUrl(url: string, params?: ScrapeParams): Promise<ScrapeResponse | ErrorResponse>;
+    scrapeUrl<T extends zt.ZodSchema>(url: string, params?: ScrapeParams<T>): Promise<ScrapeResponse<zt.infer<T>> | ErrorResponse>;
     /**
      * This method is intended to search for a query using the Firecrawl API. However, it is not supported in version 1 of the API.
      * @param query - The search query string.
@@ -240,23 +242,23 @@ declare class FirecrawlApp {
     handleError(response: AxiosResponse, action: string): void;
 }
 interface CrawlWatcherEvents {
-    document: CustomEvent<FirecrawlDocument>;
+    document: CustomEvent<FirecrawlDocument<undefined>>;
     done: CustomEvent<{
         status: CrawlStatusResponse["status"];
-        data: FirecrawlDocument[];
+        data: FirecrawlDocument<undefined>[];
     }>;
     error: CustomEvent<{
         status: CrawlStatusResponse["status"];
-        data: FirecrawlDocument[];
+        data: FirecrawlDocument<undefined>[];
         error: string;
     }>;
 }
 declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
     private ws;
-    data: FirecrawlDocument[];
+    data: FirecrawlDocument<undefined>[];
     status: CrawlStatusResponse["status"];
     constructor(id: string, app: FirecrawlApp);
     close(): void;
 }
 
-export { type CrawlParams, type CrawlResponse, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };
+export { type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { AxiosRequestHeaders, AxiosResponse } from 'axios';
-import { ZodSchema } from 'zod';
+import * as zt from 'zod';
 import { TypedEventTarget } from 'typescript-event-target';
 
 /**
@@ -54,13 +54,13 @@ interface FirecrawlDocumentMetadata {
  * Document interface for Firecrawl.
  * Represents a document retrieved or processed by Firecrawl.
  */
-interface FirecrawlDocument {
+interface FirecrawlDocument<T> {
     url?: string;
     markdown?: string;
     html?: string;
     rawHtml?: string;
     links?: string[];
-    extract?: Record<any, any>;
+    extract?: T;
     screenshot?: string;
     metadata?: FirecrawlDocumentMetadata;
 }
@@ -68,25 +68,27 @@ interface FirecrawlDocument {
  * Parameters for scraping operations.
  * Defines the options and configurations available for scraping web content.
  */
-interface ScrapeParams {
+interface CrawlScrapeOptions {
     formats: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "extract" | "full@scrennshot")[];
     headers?: Record<string, string>;
     includeTags?: string[];
     excludeTags?: string[];
     onlyMainContent?: boolean;
+    waitFor?: number;
+    timeout?: number;
+}
+interface ScrapeParams<LLMSchema extends zt.ZodSchema> extends CrawlScrapeOptions {
     extract?: {
         prompt?: string;
-        schema?: ZodSchema | any;
+        schema?: LLMSchema;
         systemPrompt?: string;
     };
-    waitFor?: number;
-    timeout?: number;
 }
 /**
  * Response interface for scraping operations.
  * Defines the structure of the response received after a scraping operation.
  */
-interface ScrapeResponse extends FirecrawlDocument {
+interface ScrapeResponse<LLMResult> extends FirecrawlDocument<LLMResult> {
     success: true;
     warning?: string;
     error?: string;
@@ -103,7 +105,7 @@ interface CrawlParams {
     allowBackwardLinks?: boolean;
     allowExternalLinks?: boolean;
     ignoreSitemap?: boolean;
-    scrapeOptions?: ScrapeParams;
+    scrapeOptions?: CrawlScrapeOptions;
     webhook?: string;
 }
 /**
@@ -128,7 +130,7 @@ interface CrawlStatusResponse {
     creditsUsed: number;
     expiresAt: Date;
     next?: string;
-    data: FirecrawlDocument[];
+    data: FirecrawlDocument<undefined>[];
 }
 /**
  * Parameters for mapping operations.
@@ -175,7 +177,7 @@ declare class FirecrawlApp {
      * @param params - Additional parameters for the scrape request.
      * @returns The response from the scrape operation.
      */
-    scrapeUrl(url: string, params?: ScrapeParams): Promise<ScrapeResponse | ErrorResponse>;
+    scrapeUrl<T extends zt.ZodSchema>(url: string, params?: ScrapeParams<T>): Promise<ScrapeResponse<zt.infer<T>> | ErrorResponse>;
     /**
      * This method is intended to search for a query using the Firecrawl API. However, it is not supported in version 1 of the API.
      * @param query - The search query string.
@@ -240,23 +242,23 @@ declare class FirecrawlApp {
     handleError(response: AxiosResponse, action: string): void;
 }
 interface CrawlWatcherEvents {
-    document: CustomEvent<FirecrawlDocument>;
+    document: CustomEvent<FirecrawlDocument<undefined>>;
     done: CustomEvent<{
         status: CrawlStatusResponse["status"];
-        data: FirecrawlDocument[];
+        data: FirecrawlDocument<undefined>[];
     }>;
     error: CustomEvent<{
         status: CrawlStatusResponse["status"];
-        data: FirecrawlDocument[];
+        data: FirecrawlDocument<undefined>[];
         error: string;
     }>;
 }
 declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
     private ws;
-    data: FirecrawlDocument[];
+    data: FirecrawlDocument<undefined>[];
     status: CrawlStatusResponse["status"];
     constructor(id: string, app: FirecrawlApp);
     close(): void;
 }
 
-export { type CrawlParams, type CrawlResponse, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };
+export { type CrawlParams, type CrawlResponse, type CrawlScrapeOptions, type CrawlStatusResponse, CrawlWatcher, type ErrorResponse, type FirecrawlAppConfig, type FirecrawlDocument, type FirecrawlDocumentMetadata, type MapParams, type MapResponse, type ScrapeParams, type ScrapeResponse, FirecrawlApp as default };

package/package.json

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

package/src/index.ts

@@ -1,5 +1,5 @@
 import axios, { type AxiosResponse, type AxiosRequestHeaders } from "axios";
-import type { ZodSchema } from "zod";
+import type * as zt from "zod";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import { WebSocket } from "isows";
 import { TypedEventTarget } from "typescript-event-target";
@@ -58,13 +58,13 @@ export interface FirecrawlDocumentMetadata {
  * Document interface for Firecrawl.
  * Represents a document retrieved or processed by Firecrawl.
  */
-export interface FirecrawlDocument {
+export interface FirecrawlDocument<T> {
   url?: string;
   markdown?: string;
   html?: string;
   rawHtml?: string;
   links?: string[];
-  extract?: Record<any, any>;
+  extract?: T;
   screenshot?: string;
   metadata?: FirecrawlDocumentMetadata;
 }
@@ -73,26 +73,29 @@ export interface FirecrawlDocument {
  * Parameters for scraping operations.
  * Defines the options and configurations available for scraping web content.
  */
-export interface ScrapeParams {
+export interface CrawlScrapeOptions {
   formats: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "extract" | "full@scrennshot")[];
   headers?: Record<string, string>;
   includeTags?: string[];
   excludeTags?: string[];
   onlyMainContent?: boolean;
+  waitFor?: number;
+  timeout?: number;
+}
+
+export interface ScrapeParams<LLMSchema extends zt.ZodSchema> extends CrawlScrapeOptions {
   extract?: {
     prompt?: string;
-    schema?: ZodSchema | any;
+    schema?: LLMSchema;
     systemPrompt?: string;
   };
-  waitFor?: number;
-  timeout?: number;
 }
 
 /**
  * Response interface for scraping operations.
  * Defines the structure of the response received after a scraping operation.
  */
-export interface ScrapeResponse extends FirecrawlDocument {
+export interface ScrapeResponse<LLMResult> extends FirecrawlDocument<LLMResult> {
   success: true;
   warning?: string;
   error?: string;
@@ -110,7 +113,7 @@ export interface CrawlParams {
   allowBackwardLinks?: boolean;
   allowExternalLinks?: boolean;
   ignoreSitemap?: boolean;
-  scrapeOptions?: ScrapeParams;
+  scrapeOptions?: CrawlScrapeOptions;
   webhook?: string;
 }
 
@@ -137,7 +140,7 @@ export interface CrawlStatusResponse {
   creditsUsed: number;
   expiresAt: Date;
   next?: string;
-  data: FirecrawlDocument[];
+  data: FirecrawlDocument<undefined>[];
 };
 
 /**
@@ -197,10 +200,10 @@ export default class FirecrawlApp {
    * @param params - Additional parameters for the scrape request.
    * @returns The response from the scrape operation.
    */
-  async scrapeUrl(
+  async scrapeUrl<T extends zt.ZodSchema>(
     url: string,
-    params?: ScrapeParams
-  ): Promise<ScrapeResponse | ErrorResponse> {
+    params?: ScrapeParams<T>
+  ): Promise<ScrapeResponse<zt.infer<T>> | ErrorResponse> {
     const headers: AxiosRequestHeaders = {
       "Content-Type": "application/json",
       Authorization: `Bearer ${this.apiKey}`,
@@ -528,21 +531,21 @@ export default class FirecrawlApp {
 }
 
 interface CrawlWatcherEvents {
-  document: CustomEvent<FirecrawlDocument>,
+  document: CustomEvent<FirecrawlDocument<undefined>>,
   done: CustomEvent<{
     status: CrawlStatusResponse["status"];
-    data: FirecrawlDocument[];
+    data: FirecrawlDocument<undefined>[];
   }>,
   error: CustomEvent<{
     status: CrawlStatusResponse["status"],
-    data: FirecrawlDocument[],
+    data: FirecrawlDocument<undefined>[],
     error: string,
   }>,
 }
 
 export class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
   private ws: WebSocket;
-  public data: FirecrawlDocument[];
+  public data: FirecrawlDocument<undefined>[];
   public status: CrawlStatusResponse["status"];
 
   constructor(id: string, app: FirecrawlApp) {
@@ -563,7 +566,7 @@ export class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
     
     type DocumentMessage = {
       type: "document",
-      data: FirecrawlDocument,
+      data: FirecrawlDocument<undefined>,
     }
     
     type DoneMessage = { type: "done" }