v-firecrawl/apps/js-sdk/firecrawl/build/index.js

var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
import axios from "axios";
import { z } from "zod";
import { zodToJsonSchema } from "zod-to-json-schema";
/**
 * Main class for interacting with the Firecrawl API.
 */
export default class FirecrawlApp {
    /**
     * Initializes a new instance of the FirecrawlApp class.
     * @param {FirecrawlAppConfig} config - Configuration options for the FirecrawlApp instance.
     */
    constructor({ apiKey = null }) {
        this.apiKey = apiKey || "";
        if (!this.apiKey) {
            throw new Error("No API key provided");
        }
    }
    /**
     * Scrapes a URL using the Firecrawl API.
     * @param {string} url - The URL to scrape.
     * @param {Params | null} params - Additional parameters for the scrape request.
     * @returns {Promise<ScrapeResponse>} The response from the scrape operation.
     */
    scrapeUrl(url_1) {
        return __awaiter(this, arguments, void 0, function* (url, params = null) {
            var _a;
            const headers = {
                "Content-Type": "application/json",
                Authorization: `Bearer ${this.apiKey}`,
            };
            let jsonData = Object.assign({ url }, params);
            if ((_a = params === null || params === void 0 ? void 0 : params.extractorOptions) === null || _a === void 0 ? void 0 : _a.extractionSchema) {
                let schema = params.extractorOptions.extractionSchema;
                // Check if schema is an instance of ZodSchema to correctly identify Zod schemas
                if (schema instanceof z.ZodSchema) {
                    schema = zodToJsonSchema(schema);
                }
                jsonData = Object.assign(Object.assign({}, jsonData), { extractorOptions: Object.assign(Object.assign({}, params.extractorOptions), { extractionSchema: schema, mode: params.extractorOptions.mode || "llm-extraction" }) });
            }
            try {
                const response = yield axios.post("https://api.firecrawl.dev/v0/scrape", jsonData, { headers });
                if (response.status === 200) {
                    const responseData = response.data;
                    if (responseData.success) {
                        return responseData;
                    }
                    else {
                        throw new Error(`Failed to scrape URL. Error: ${responseData.error}`);
                    }
                }
                else {
                    this.handleError(response, "scrape URL");
                }
            }
            catch (error) {
                throw new Error(error.message);
            }
            return { success: false, error: "Internal server error." };
        });
    }
    /**
     * Searches for a query using the Firecrawl API.
     * @param {string} query - The query to search for.
     * @param {Params | null} params - Additional parameters for the search request.
     * @returns {Promise<SearchResponse>} The response from the search operation.
     */
    search(query_1) {
        return __awaiter(this, arguments, void 0, function* (query, params = null) {
            const headers = {
                "Content-Type": "application/json",
                Authorization: `Bearer ${this.apiKey}`,
            };
            let jsonData = { query };
            if (params) {
                jsonData = Object.assign(Object.assign({}, jsonData), params);
            }
            try {
                const response = yield axios.post("https://api.firecrawl.dev/v0/search", jsonData, { headers });
                if (response.status === 200) {
                    const responseData = response.data;
                    if (responseData.success) {
                        return responseData;
                    }
                    else {
                        throw new Error(`Failed to search. Error: ${responseData.error}`);
                    }
                }
                else {
                    this.handleError(response, "search");
                }
            }
            catch (error) {
                throw new Error(error.message);
            }
            return { success: false, error: "Internal server error." };
        });
    }
    /**
     * Initiates a crawl job for a URL using the Firecrawl API.
     * @param {string} url - The URL to crawl.
     * @param {Params | null} params - Additional parameters for the crawl request.
     * @param {boolean} waitUntilDone - Whether to wait for the crawl job to complete.
     * @param {number} timeout - Timeout in seconds for job status checks.
     * @param {string} idempotencyKey - Optional idempotency key for the request.
     * @returns {Promise<CrawlResponse | any>} The response from the crawl operation.
     */
    crawlUrl(url_1) {
        return __awaiter(this, arguments, void 0, function* (url, params = null, waitUntilDone = true, timeout = 2, idempotencyKey) {
            const headers = this.prepareHeaders(idempotencyKey);
            let jsonData = { url };
            if (params) {
                jsonData = Object.assign(Object.assign({}, jsonData), params);
            }
            try {
                const response = yield this.postRequest("https://api.firecrawl.dev/v0/crawl", jsonData, headers);
                if (response.status === 200) {
                    const jobId = response.data.jobId;
                    if (waitUntilDone) {
                        return this.monitorJobStatus(jobId, headers, timeout);
                    }
                    else {
                        return { success: true, jobId };
                    }
                }
                else {
                    this.handleError(response, "start crawl job");
                }
            }
            catch (error) {
                console.log(error);
                throw new Error(error.message);
            }
            return { success: false, error: "Internal server error." };
        });
    }
    /**
     * Checks the status of a crawl job using the Firecrawl API.
     * @param {string} jobId - The job ID of the crawl operation.
     * @returns {Promise<JobStatusResponse>} The response containing the job status.
     */
    checkCrawlStatus(jobId) {
        return __awaiter(this, void 0, void 0, function* () {
            const headers = this.prepareHeaders();
            try {
                const response = yield this.getRequest(`https://api.firecrawl.dev/v0/crawl/status/${jobId}`, headers);
                if (response.status === 200) {
                    return response.data;
                }
                else {
                    this.handleError(response, "check crawl status");
                }
            }
            catch (error) {
                throw new Error(error.message);
            }
            return {
                success: false,
                status: "unknown",
                error: "Internal server error.",
            };
        });
    }
    /**
     * Prepares the headers for an API request.
     * @returns {AxiosRequestHeaders} The prepared headers.
     */
    prepareHeaders(idempotencyKey) {
        return Object.assign({ 'Content-Type': 'application/json', 'Authorization': `Bearer ${this.apiKey}` }, (idempotencyKey ? { 'x-idempotency-key': idempotencyKey } : {}));
    }
    /**
     * Sends a POST request to the specified URL.
     * @param {string} url - The URL to send the request to.
     * @param {Params} data - The data to send in the request.
     * @param {AxiosRequestHeaders} headers - The headers for the request.
     * @returns {Promise<AxiosResponse>} The response from the POST request.
     */
    postRequest(url, data, headers) {
        return axios.post(url, data, { headers });
    }
    /**
     * Sends a GET request to the specified URL.
     * @param {string} url - The URL to send the request to.
     * @param {AxiosRequestHeaders} headers - The headers for the request.
     * @returns {Promise<AxiosResponse>} The response from the GET request.
     */
    getRequest(url, headers) {
        return axios.get(url, { headers });
    }
    /**
     * Monitors the status of a crawl job until completion or failure.
     * @param {string} jobId - The job ID of the crawl operation.
     * @param {AxiosRequestHeaders} headers - The headers for the request.
     * @param {number} timeout - Timeout in seconds for job status checks.
     * @returns {Promise<any>} The final job status or data.
     */
    monitorJobStatus(jobId, headers, timeout) {
        return __awaiter(this, void 0, void 0, function* () {
            while (true) {
                const statusResponse = yield this.getRequest(`https://api.firecrawl.dev/v0/crawl/status/${jobId}`, headers);
                if (statusResponse.status === 200) {
                    const statusData = statusResponse.data;
                    if (statusData.status === "completed") {
                        if ("data" in statusData) {
                            return statusData.data;
                        }
                        else {
                            throw new Error("Crawl job completed but no data was returned");
                        }
                    }
                    else if (["active", "paused", "pending", "queued"].includes(statusData.status)) {
                        if (timeout < 2) {
                            timeout = 2;
                        }
                        yield new Promise((resolve) => setTimeout(resolve, timeout * 1000)); // Wait for the specified timeout before checking again
                    }
                    else {
                        throw new Error(`Crawl job failed or was stopped. Status: ${statusData.status}`);
                    }
                }
                else {
                    this.handleError(statusResponse, "check crawl status");
                }
            }
        });
    }
    /**
     * Handles errors from API responses.
     * @param {AxiosResponse} response - The response from the API.
     * @param {string} action - The action being performed when the error occurred.
     */
    handleError(response, action) {
        if ([402, 408, 409, 500].includes(response.status)) {
            const errorMessage = response.data.error || "Unknown error occurred";
            throw new Error(`Failed to ${action}. Status code: ${response.status}. Error: ${errorMessage}`);
        }
        else {
            throw new Error(`Unexpected error occurred while trying to ${action}. Status code: ${response.status}`);
        }
    }
}