@mendable/firecrawl-js 0.0.16 → 0.0.17-beta.2

package/build/index.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import axios from 'axios';
+import { zodToJsonSchema } from 'zod-to-json-schema';
 /**
  * Main class for interacting with the Firecrawl API.
  */
@@ -29,7 +30,7 @@ export default class FirecrawlApp {
      * @returns {Promise<ScrapeResponse>} The response from the scrape operation.
      */
     scrapeUrl(url_1) {
-        return __awaiter(this, arguments, void 0, function* (url, params = null) {
+        return __awaiter(this, arguments, void 0, function* (url, params = null, extractorOptions) {
             const headers = {
                 'Content-Type': 'application/json',
                 'Authorization': `Bearer ${this.apiKey}`,
@@ -38,6 +39,10 @@ export default class FirecrawlApp {
             if (params) {
                 jsonData = Object.assign(Object.assign({}, jsonData), params);
             }
+            if (extractorOptions === null || extractorOptions === void 0 ? void 0 : extractorOptions.schema) {
+                const schema = zodToJsonSchema(extractorOptions.schema);
+                jsonData = Object.assign(Object.assign({}, jsonData), { extractorOptions: Object.assign(Object.assign({}, extractorOptions), { schema }) });
+            }
             try {
                 const response = yield axios.post('https://api.firecrawl.dev/v0/scrape', jsonData, { headers });
                 if (response.status === 200) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mendable/firecrawl-js",
-  "version": "0.0.16",
+  "version": "0.0.17-beta.2",
   "description": "JavaScript SDK for Firecrawl API",
   "main": "build/index.js",
   "types": "types/index.d.ts",
@@ -8,6 +8,7 @@
   "scripts": {
     "build": "tsc",
     "publish": "npm run build && npm publish --access public",
+    "publish-beta": "npm run build && npm publish --access public --tag beta",
     "test": "jest src/**/*.test.ts"
   },
   "repository": {
@@ -17,7 +18,8 @@
   "author": "Mendable.ai",
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.6.8"
+    "axios": "^1.6.8",
+    "zod": "^3.23.8"
   },
   "bugs": {
     "url": "https://github.com/mendableai/firecrawl/issues"
@@ -29,7 +31,8 @@
     "@types/node": "^20.12.7",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.2",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "zod-to-json-schema": "^3.23.0"
   },
   "keywords": [
     "firecrawl",

package/src/index.ts

@@ -1,5 +1,6 @@
 import axios, { AxiosResponse, AxiosRequestHeaders } from 'axios';
-
+import { z } from 'zod';
+import { zodToJsonSchema } from 'zod-to-json-schema'
 /**
  * Configuration interface for FirecrawlApp.
  */
@@ -75,7 +76,7 @@ export default class FirecrawlApp {
    * @param {Params | null} params - Additional parameters for the scrape request.
    * @returns {Promise<ScrapeResponse>} The response from the scrape operation.
    */
-  async scrapeUrl(url: string, params: Params | null = null): Promise<ScrapeResponse> {
+  async scrapeUrl(url: string, params: Params | null = null, extractorOptions?: { schema?: z.ZodType<any, any> }): Promise<ScrapeResponse> {
     const headers: AxiosRequestHeaders = {
       'Content-Type': 'application/json',
       'Authorization': `Bearer ${this.apiKey}`,
@@ -84,6 +85,10 @@ export default class FirecrawlApp {
     if (params) {
       jsonData = { ...jsonData, ...params };
     }
+    if (extractorOptions?.schema) {
+      const schema = zodToJsonSchema(extractorOptions.schema);
+      jsonData = { ...jsonData, extractorOptions: { ...extractorOptions, schema } };
+    }
     try {
       const response: AxiosResponse = await axios.post('https://api.firecrawl.dev/v0/scrape', jsonData, { headers });
       if (response.status === 200) {

package/types/index.d.ts

@@ -1,4 +1,5 @@
 import { AxiosResponse, AxiosRequestHeaders } from 'axios';
+import { z } from 'zod';
 /**
  * Configuration interface for FirecrawlApp.
  */
@@ -62,7 +63,9 @@ export default class FirecrawlApp {
      * @param {Params | null} params - Additional parameters for the scrape request.
      * @returns {Promise<ScrapeResponse>} The response from the scrape operation.
      */
-    scrapeUrl(url: string, params?: Params | null): Promise<ScrapeResponse>;
+    scrapeUrl(url: string, params?: Params | null, extractorOptions?: {
+        schema?: z.ZodType<any, any>;
+    }): Promise<ScrapeResponse>;
     /**
      * Searches for a query using the Firecrawl API.
      * @param {string} query - The query to search for.