@mendable/firecrawl-js 1.0.4 → 1.2.0

package/types/index.d.ts

@@ -1,15 +1,14 @@
 import { AxiosResponse, AxiosRequestHeaders } from "axios";
 import { z } from "zod";
+import { TypedEventTarget } from "typescript-event-target";
 /**
  * Configuration interface for FirecrawlApp.
  * @param apiKey - Optional API key for authentication.
  * @param apiUrl - Optional base URL of the API; defaults to 'https://api.firecrawl.dev'.
- * @param version - API version, either 'v0' or 'v1'.
  */
 export interface FirecrawlAppConfig {
     apiKey?: string | null;
     apiUrl?: string | null;
-    version?: "v0" | "v1";
 }
 /**
  * Metadata for a Firecrawl document.
@@ -50,15 +49,6 @@ export interface FirecrawlDocumentMetadata {
     error?: string;
     [key: string]: any;
 }
-/**
- * Metadata for a Firecrawl document on v0.
- * Similar to FirecrawlDocumentMetadata but includes properties specific to API version v0.
- */
-export interface FirecrawlDocumentMetadataV0 {
-    pageStatusCode?: number;
-    pageError?: string;
-    [key: string]: any;
-}
 /**
  * Document interface for Firecrawl.
  * Represents a document retrieved or processed by Firecrawl.
@@ -69,65 +59,26 @@ export interface FirecrawlDocument {
     html?: string;
     rawHtml?: string;
     links?: string[];
+    extract?: Record<any, any>;
     screenshot?: string;
-    metadata: FirecrawlDocumentMetadata;
-}
-/**
- * Document interface for Firecrawl on v0.
- * Represents a document specifically for API version v0 with additional properties.
- */
-export interface FirecrawlDocumentV0 {
-    id?: string;
-    url?: string;
-    content: string;
-    markdown?: string;
-    html?: string;
-    llm_extraction?: Record<string, any>;
-    createdAt?: Date;
-    updatedAt?: Date;
-    type?: string;
-    metadata: FirecrawlDocumentMetadataV0;
-    childrenLinks?: string[];
-    provider?: string;
-    warning?: string;
-    index?: number;
+    metadata?: FirecrawlDocumentMetadata;
 }
 /**
  * Parameters for scraping operations.
  * Defines the options and configurations available for scraping web content.
  */
 export interface ScrapeParams {
-    formats: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot")[];
+    formats: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "extract" | "full@scrennshot")[];
     headers?: Record<string, string>;
     includeTags?: string[];
     excludeTags?: string[];
     onlyMainContent?: boolean;
-    screenshotMode?: "desktop" | "full-desktop" | "mobile" | "full-mobile";
-    waitFor?: number;
-    timeout?: number;
-}
-/**
- * Parameters for scraping operations on v0.
- * Includes page and extractor options specific to API version v0.
- */
-export interface ScrapeParamsV0 {
-    pageOptions?: {
-        headers?: Record<string, string>;
-        includeHtml?: boolean;
-        includeRawHtml?: boolean;
-        onlyIncludeTags?: string[];
-        onlyMainContent?: boolean;
-        removeTags?: string[];
-        replaceAllPathsWithAbsolutePaths?: boolean;
-        screenshot?: boolean;
-        fullPageScreenshot?: boolean;
-        waitFor?: number;
-    };
-    extractorOptions?: {
-        mode?: "markdown" | "llm-extraction" | "llm-extraction-from-raw-html" | "llm-extraction-from-markdown";
-        extractionPrompt?: string;
-        extractionSchema?: Record<string, any> | z.ZodSchema | any;
+    extract?: {
+        prompt?: string;
+        schema?: z.ZodSchema | any;
+        systemPrompt?: string;
     };
+    waitFor?: number;
     timeout?: number;
 }
 /**
@@ -135,19 +86,10 @@ export interface ScrapeParamsV0 {
  * Defines the structure of the response received after a scraping operation.
  */
 export interface ScrapeResponse extends FirecrawlDocument {
-    success: boolean;
+    success: true;
     warning?: string;
     error?: string;
 }
-/**
- * Response interface for scraping operations on v0.
- * Similar to ScrapeResponse but tailored for responses from API version v0.
- */
-export interface ScrapeResponseV0 {
-    success: boolean;
-    data?: FirecrawlDocumentV0;
-    error?: string;
-}
 /**
  * Parameters for crawling operations.
  * Includes options for both scraping and mapping during a crawl.
@@ -162,36 +104,6 @@ export interface CrawlParams {
     ignoreSitemap?: boolean;
     scrapeOptions?: ScrapeParams;
 }
-/**
- * Parameters for crawling operations on v0.
- * Tailored for API version v0, includes specific options for crawling.
- */
-export interface CrawlParamsV0 {
-    crawlerOptions?: {
-        includes?: string[];
-        excludes?: string[];
-        generateImgAltText?: boolean;
-        returnOnlyUrls?: boolean;
-        maxDepth?: number;
-        mode?: "default" | "fast";
-        ignoreSitemap?: boolean;
-        limit?: number;
-        allowBackwardCrawling?: boolean;
-        allowExternalContentLinks?: boolean;
-    };
-    pageOptions?: {
-        headers?: Record<string, string>;
-        includeHtml?: boolean;
-        includeRawHtml?: boolean;
-        onlyIncludeTags?: string[];
-        onlyMainContent?: boolean;
-        removeTags?: string[];
-        replaceAllPathsWithAbsolutePaths?: boolean;
-        screenshot?: boolean;
-        fullPageScreenshot?: boolean;
-        waitFor?: number;
-    };
-}
 /**
  * Response interface for crawling operations.
  * Defines the structure of the response received after initiating a crawl.
@@ -199,16 +111,7 @@ export interface CrawlParamsV0 {
 export interface CrawlResponse {
     id?: string;
     url?: string;
-    success: boolean;
-    error?: string;
-}
-/**
- * Response interface for crawling operations on v0.
- * Similar to CrawlResponse but tailored for responses from API version v0.
- */
-export interface CrawlResponseV0 {
-    jobId?: string;
-    success: boolean;
+    success: true;
     error?: string;
 }
 /**
@@ -216,7 +119,7 @@ export interface CrawlResponseV0 {
  * Provides detailed status of a crawl job including progress and results.
  */
 export interface CrawlStatusResponse {
-    success: boolean;
+    success: true;
     total: number;
     completed: number;
     creditsUsed: number;
@@ -226,21 +129,6 @@ export interface CrawlStatusResponse {
     data?: FirecrawlDocument[];
     error?: string;
 }
-/**
- * Response interface for job status checks on v0.
- * Tailored for API version v0, provides status and partial data of a crawl job.
- */
-export interface CrawlStatusResponseV0 {
-    success: boolean;
-    status: string;
-    current?: number;
-    current_url?: string;
-    current_step?: string;
-    total?: number;
-    data?: FirecrawlDocumentV0[];
-    partial_data?: FirecrawlDocumentV0[];
-    error?: string;
-}
 /**
  * Parameters for mapping operations.
  * Defines options for mapping URLs during a crawl.
@@ -256,78 +144,62 @@ export interface MapParams {
  * Defines the structure of the response received after a mapping operation.
  */
 export interface MapResponse {
-    success: boolean;
+    success: true;
     links?: string[];
     error?: string;
 }
 /**
- * Parameters for searching operations on v0.
- * Tailored for API version v0, includes specific options for searching content.
+ * Error response interface.
+ * Defines the structure of the response received when an error occurs.
  */
-export interface SearchParamsV0 {
-    pageOptions?: {
-        onlyMainContent?: boolean;
-        fetchPageContent?: boolean;
-        includeHtml?: boolean;
-        includeRawHtml?: boolean;
-    };
-    searchOptions?: {
-        limit?: number;
-    };
-}
-/**
- * Response interface for searching operations on v0.
- * Defines the structure of the response received after a search operation on v0.
- */
-export interface SearchResponseV0 {
-    success: boolean;
-    data?: FirecrawlDocumentV0[];
-    error?: string;
+export interface ErrorResponse {
+    success: false;
+    error: string;
 }
 /**
  * Main class for interacting with the Firecrawl API.
  * Provides methods for scraping, searching, crawling, and mapping web content.
  */
-export default class FirecrawlApp<T extends "v0" | "v1"> {
-    private apiKey;
-    private apiUrl;
-    version: T;
+export default class FirecrawlApp {
+    apiKey: string;
+    apiUrl: string;
     /**
      * Initializes a new instance of the FirecrawlApp class.
      * @param config - Configuration options for the FirecrawlApp instance.
      */
-    constructor({ apiKey, apiUrl, version }: FirecrawlAppConfig);
+    constructor({ apiKey, apiUrl }: FirecrawlAppConfig);
     /**
      * Scrapes a URL using the Firecrawl API.
      * @param url - The URL to scrape.
      * @param params - Additional parameters for the scrape request.
      * @returns The response from the scrape operation.
      */
-    scrapeUrl(url: string, params?: ScrapeParams | ScrapeParamsV0): Promise<this['version'] extends 'v0' ? ScrapeResponseV0 : ScrapeResponse>;
+    scrapeUrl(url: string, params?: ScrapeParams): Promise<ScrapeResponse | ErrorResponse>;
     /**
-     * Searches for a query using the Firecrawl API.
-     * @param query - The query to search for.
-     * @param params - Additional parameters for the search request.
-     * @returns The response from the search operation.
+     * 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.
+     * @param params - Additional parameters for the search.
+     * @returns Throws an error advising to use version 0 of the API.
      */
-    search(query: string, params?: SearchParamsV0): Promise<SearchResponseV0>;
+    search(query: string, params?: any): Promise<any>;
     /**
      * Initiates a crawl job for a URL using the Firecrawl API.
      * @param url - The URL to crawl.
      * @param params - Additional parameters for the crawl request.
-     * @param waitUntilDone - Whether to wait for the crawl job to complete.
      * @param pollInterval - Time in seconds for job status checks.
      * @param idempotencyKey - Optional idempotency key for the request.
      * @returns The response from the crawl operation.
      */
-    crawlUrl(url: string, params?: this['version'] extends 'v0' ? CrawlParamsV0 : CrawlParams, waitUntilDone?: boolean, pollInterval?: number, idempotencyKey?: string): Promise<this['version'] extends 'v0' ? CrawlResponseV0 | CrawlStatusResponseV0 | FirecrawlDocumentV0[] : CrawlResponse | CrawlStatusResponse>;
+    crawlUrl(url: string, params?: CrawlParams, pollInterval?: number, idempotencyKey?: string): Promise<CrawlStatusResponse | ErrorResponse>;
+    asyncCrawlUrl(url: string, params?: CrawlParams, idempotencyKey?: string): Promise<CrawlResponse | ErrorResponse>;
     /**
      * Checks the status of a crawl job using the Firecrawl API.
      * @param id - The ID of the crawl operation.
      * @returns The response containing the job status.
      */
-    checkCrawlStatus(id?: string): Promise<this['version'] extends 'v0' ? CrawlStatusResponseV0 : CrawlStatusResponse>;
-    mapUrl(url: string, params?: MapParams): Promise<MapResponse>;
+    checkCrawlStatus(id?: string): Promise<CrawlStatusResponse | ErrorResponse>;
+    crawlUrlAndWatch(url: string, params?: CrawlParams, idempotencyKey?: string): Promise<CrawlWatcher>;
+    mapUrl(url: string, params?: MapParams): Promise<MapResponse | ErrorResponse>;
     /**
      * Prepares the headers for an API request.
      * @param idempotencyKey - Optional key to ensure idempotency.
@@ -357,7 +229,7 @@ export default class FirecrawlApp<T extends "v0" | "v1"> {
      * @param checkUrl - Optional URL to check the status (used for v1 API)
      * @returns The final job status or data.
      */
-    monitorJobStatus(id: string, headers: AxiosRequestHeaders, checkInterval: number, checkUrl?: string): Promise<this['version'] extends 'v0' ? CrawlStatusResponseV0 | FirecrawlDocumentV0[] : CrawlStatusResponse>;
+    monitorJobStatus(id: string, headers: AxiosRequestHeaders, checkInterval: number): Promise<CrawlStatusResponse>;
     /**
      * Handles errors from API responses.
      * @param {AxiosResponse} response - The response from the API.
@@ -365,3 +237,23 @@ export default class FirecrawlApp<T extends "v0" | "v1"> {
      */
     handleError(response: AxiosResponse, action: string): void;
 }
+interface CrawlWatcherEvents {
+    document: CustomEvent<FirecrawlDocument>;
+    done: CustomEvent<{
+        status: CrawlStatusResponse["status"];
+        data: FirecrawlDocument[];
+    }>;
+    error: CustomEvent<{
+        status: CrawlStatusResponse["status"];
+        data: FirecrawlDocument[];
+        error: string;
+    }>;
+}
+export declare class CrawlWatcher extends TypedEventTarget<CrawlWatcherEvents> {
+    private ws;
+    data: FirecrawlDocument[];
+    status: CrawlStatusResponse["status"];
+    constructor(id: string, app: FirecrawlApp);
+    close(): void;
+}
+export {};