firecrawl 1.4.4 → 1.5.0

package/dist/index.d.cts

@@ -54,7 +54,7 @@ interface FirecrawlDocumentMetadata {
  * Document interface for Firecrawl.
  * Represents a document retrieved or processed by Firecrawl.
  */
-interface FirecrawlDocument<T> {
+interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult | never) = never> {
     url?: string;
     markdown?: string;
     html?: string;
@@ -63,6 +63,7 @@ interface FirecrawlDocument<T> {
     extract?: T;
     screenshot?: string;
     metadata?: FirecrawlDocumentMetadata;
+    actions: ActionsSchema;
 }
 /**
  * Parameters for scraping operations.
@@ -77,18 +78,41 @@ interface CrawlScrapeOptions {
     waitFor?: number;
     timeout?: number;
 }
-interface ScrapeParams<LLMSchema extends zt.ZodSchema> extends CrawlScrapeOptions {
+type Action = {
+    type: "wait";
+    milliseconds: number;
+} | {
+    type: "click";
+    selector: string;
+} | {
+    type: "screenshot";
+    fullPage?: boolean;
+} | {
+    type: "typeText";
+    text: string;
+} | {
+    type: "pressKey";
+    key: string;
+} | {
+    type: "scroll";
+    direction: "up" | "down";
+};
+interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema extends (Action[] | undefined) = undefined> extends CrawlScrapeOptions {
     extract?: {
         prompt?: string;
         schema?: LLMSchema;
         systemPrompt?: string;
     };
+    actions?: ActionsSchema;
+}
+interface ActionsResult {
+    screenshots: string[];
 }
 /**
  * Response interface for scraping operations.
  * Defines the structure of the response received after a scraping operation.
  */
-interface ScrapeResponse<LLMResult> extends FirecrawlDocument<LLMResult> {
+interface ScrapeResponse<LLMResult = any, ActionsSchema extends (ActionsResult | never) = never> extends FirecrawlDocument<LLMResult, ActionsSchema> {
     success: true;
     warning?: string;
     error?: string;
@@ -177,7 +201,7 @@ declare class FirecrawlApp {
      * @param params - Additional parameters for the scrape request.
      * @returns The response from the scrape operation.
      */
-    scrapeUrl<T extends zt.ZodSchema>(url: string, params?: ScrapeParams<T>): Promise<ScrapeResponse<zt.infer<T>> | ErrorResponse>;
+    scrapeUrl<T extends zt.ZodSchema, ActionsSchema extends (Action[] | undefined) = undefined>(url: string, params?: ScrapeParams<T, ActionsSchema>): Promise<ScrapeResponse<zt.infer<T>, ActionsSchema extends Action[] ? ActionsResult : never> | 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.
@@ -261,4 +285,4 @@ declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
     close(): void;
 }
 
-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 };
+export { type Action, type ActionsResult, 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

@@ -54,7 +54,7 @@ interface FirecrawlDocumentMetadata {
  * Document interface for Firecrawl.
  * Represents a document retrieved or processed by Firecrawl.
  */
-interface FirecrawlDocument<T> {
+interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult | never) = never> {
     url?: string;
     markdown?: string;
     html?: string;
@@ -63,6 +63,7 @@ interface FirecrawlDocument<T> {
     extract?: T;
     screenshot?: string;
     metadata?: FirecrawlDocumentMetadata;
+    actions: ActionsSchema;
 }
 /**
  * Parameters for scraping operations.
@@ -77,18 +78,41 @@ interface CrawlScrapeOptions {
     waitFor?: number;
     timeout?: number;
 }
-interface ScrapeParams<LLMSchema extends zt.ZodSchema> extends CrawlScrapeOptions {
+type Action = {
+    type: "wait";
+    milliseconds: number;
+} | {
+    type: "click";
+    selector: string;
+} | {
+    type: "screenshot";
+    fullPage?: boolean;
+} | {
+    type: "typeText";
+    text: string;
+} | {
+    type: "pressKey";
+    key: string;
+} | {
+    type: "scroll";
+    direction: "up" | "down";
+};
+interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema extends (Action[] | undefined) = undefined> extends CrawlScrapeOptions {
     extract?: {
         prompt?: string;
         schema?: LLMSchema;
         systemPrompt?: string;
     };
+    actions?: ActionsSchema;
+}
+interface ActionsResult {
+    screenshots: string[];
 }
 /**
  * Response interface for scraping operations.
  * Defines the structure of the response received after a scraping operation.
  */
-interface ScrapeResponse<LLMResult> extends FirecrawlDocument<LLMResult> {
+interface ScrapeResponse<LLMResult = any, ActionsSchema extends (ActionsResult | never) = never> extends FirecrawlDocument<LLMResult, ActionsSchema> {
     success: true;
     warning?: string;
     error?: string;
@@ -177,7 +201,7 @@ declare class FirecrawlApp {
      * @param params - Additional parameters for the scrape request.
      * @returns The response from the scrape operation.
      */
-    scrapeUrl<T extends zt.ZodSchema>(url: string, params?: ScrapeParams<T>): Promise<ScrapeResponse<zt.infer<T>> | ErrorResponse>;
+    scrapeUrl<T extends zt.ZodSchema, ActionsSchema extends (Action[] | undefined) = undefined>(url: string, params?: ScrapeParams<T, ActionsSchema>): Promise<ScrapeResponse<zt.infer<T>, ActionsSchema extends Action[] ? ActionsResult : never> | 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.
@@ -261,4 +285,4 @@ declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
     close(): void;
 }
 
-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 };
+export { type Action, type ActionsResult, 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.4.4",
+  "version": "1.5.0",
   "description": "JavaScript SDK for Firecrawl API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -58,7 +58,7 @@ export interface FirecrawlDocumentMetadata {
  * Document interface for Firecrawl.
  * Represents a document retrieved or processed by Firecrawl.
  */
-export interface FirecrawlDocument<T> {
+export interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult | never) = never> {
   url?: string;
   markdown?: string;
   html?: string;
@@ -67,6 +67,7 @@ export interface FirecrawlDocument<T> {
   extract?: T;
   screenshot?: string;
   metadata?: FirecrawlDocumentMetadata;
+  actions: ActionsSchema;
 }
 
 /**
@@ -83,19 +84,44 @@ export interface CrawlScrapeOptions {
   timeout?: number;
 }
 
-export interface ScrapeParams<LLMSchema extends zt.ZodSchema> extends CrawlScrapeOptions {
+export type Action = {
+  type: "wait",
+  milliseconds: number,
+} | {
+  type: "click",
+  selector: string,
+} | {
+  type: "screenshot",
+  fullPage?: boolean,
+} | {
+  type: "typeText",
+  text: string,
+} | {
+  type: "pressKey",
+  key: string,
+} | {
+  type: "scroll",
+  direction: "up" | "down",
+};
+
+export interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchema extends (Action[] | undefined) = undefined> extends CrawlScrapeOptions {
   extract?: {
     prompt?: string;
     schema?: LLMSchema;
     systemPrompt?: string;
   };
+  actions?: ActionsSchema;
+}
+
+export interface ActionsResult {
+  screenshots: string[];
 }
 
 /**
  * Response interface for scraping operations.
  * Defines the structure of the response received after a scraping operation.
  */
-export interface ScrapeResponse<LLMResult> extends FirecrawlDocument<LLMResult> {
+export interface ScrapeResponse<LLMResult = any, ActionsSchema extends (ActionsResult | never) = never> extends FirecrawlDocument<LLMResult, ActionsSchema> {
   success: true;
   warning?: string;
   error?: string;
@@ -200,10 +226,10 @@ export default class FirecrawlApp {
    * @param params - Additional parameters for the scrape request.
    * @returns The response from the scrape operation.
    */
-  async scrapeUrl<T extends zt.ZodSchema>(
+  async scrapeUrl<T extends zt.ZodSchema, ActionsSchema extends (Action[] | undefined) = undefined>(
     url: string,
-    params?: ScrapeParams<T>
-  ): Promise<ScrapeResponse<zt.infer<T>> | ErrorResponse> {
+    params?: ScrapeParams<T, ActionsSchema>
+  ): Promise<ScrapeResponse<zt.infer<T>, ActionsSchema extends Action[] ? ActionsResult : never> | ErrorResponse> {
     const headers: AxiosRequestHeaders = {
       "Content-Type": "application/json",
       Authorization: `Bearer ${this.apiKey}`,