@mendable/firecrawl 1.22.0 → 1.23.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mendable/firecrawl",
-  "version": "1.22.0",
+  "version": "1.23.2",
   "description": "JavaScript SDK for Firecrawl API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,7 +25,6 @@
   "author": "Mendable.ai",
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.6.8",
     "typescript-event-target": "^1.1.1",
     "zod": "^3.23.8",
     "zod-to-json-schema": "^3.23.0"
@@ -38,10 +37,11 @@
     "@jest/globals": "^29.7.0",
     "@types/axios": "^0.14.0",
     "@types/dotenv": "^8.2.0",
-    "@types/jest": "^29.5.12",
+    "@types/jest": "^29.5.14",
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.12.12",
     "@types/uuid": "^9.0.8",
+    "axios": "^1.6.8",
     "dotenv": "^16.4.5",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.2",

package/src/__tests__/v1/snips/change-tracking.test.ts

@@ -0,0 +1,105 @@
+import axios from 'axios';
+import FirecrawlApp from '../../../../src/index';
+
+jest.mock('axios');
+const mockedAxios = axios as jest.Mocked<typeof axios>;
+
+describe('Change Tracking Tests', () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should support basic change tracking format', async () => {
+    mockedAxios.post.mockResolvedValueOnce({
+      status: 200,
+      data: {
+        success: true,
+        data: {
+          markdown: 'Test markdown content',
+          changeTracking: {
+            previousScrapeAt: '2023-01-01T00:00:00Z',
+            changeStatus: 'changed',
+            visibility: 'visible'
+          }
+        }
+      }
+    });
+
+    const app = new FirecrawlApp({ apiKey: process.env.TEST_API_KEY || 'dummy-api-key-for-testing' });
+    const result = await app.scrapeUrl('https://example.com', {
+      formats: ['markdown', 'changeTracking']
+    });
+
+    expect(mockedAxios.post).toHaveBeenCalledTimes(1);
+    expect(mockedAxios.post.mock.calls[0][1].formats).toContain('changeTracking');
+    
+    expect(result).toHaveProperty('changeTracking');
+    expect(result.changeTracking?.previousScrapeAt).toBe('2023-01-01T00:00:00Z');
+    expect(result.changeTracking?.changeStatus).toBe('changed');
+    expect(result.changeTracking?.visibility).toBe('visible');
+  });
+
+  it('should support change tracking options with git-diff and json modes', async () => {
+    mockedAxios.post.mockResolvedValueOnce({
+      status: 200,
+      data: {
+        success: true,
+        data: {
+          markdown: 'Test markdown content',
+          changeTracking: {
+            previousScrapeAt: '2023-01-01T00:00:00Z',
+            changeStatus: 'changed',
+            visibility: 'visible',
+            diff: {
+              text: '@@ -1,1 +1,1 @@\n-old content\n+new content',
+              json: {
+                files: [{
+                  from: null,
+                  to: null,
+                  chunks: [{
+                    content: '@@ -1,1 +1,1 @@',
+                    changes: [{
+                      type: 'del',
+                      content: '-old content',
+                      del: true,
+                      ln: 1
+                    }, {
+                      type: 'add',
+                      content: '+new content',
+                      add: true,
+                      ln: 1
+                    }]
+                  }]
+                }]
+              }
+            },
+            json: {
+              title: {
+                previous: 'Old Title',
+                current: 'New Title'
+              }
+            }
+          }
+        }
+      }
+    });
+
+    const app = new FirecrawlApp({ apiKey: process.env.TEST_API_KEY || 'dummy-api-key-for-testing' });
+    const result = await app.scrapeUrl('https://example.com', {
+      formats: ['markdown', 'changeTracking'],
+      changeTrackingOptions: {
+        modes: ['git-diff', 'json'],
+        schema: { type: 'object', properties: { title: { type: 'string' } } }
+      }
+    });
+
+    expect(mockedAxios.post).toHaveBeenCalledTimes(1);
+    expect(mockedAxios.post.mock.calls[0][1].formats).toContain('changeTracking');
+    expect(mockedAxios.post.mock.calls[0][1].changeTrackingOptions.modes).toEqual(['git-diff', 'json']);
+    
+    expect(result).toHaveProperty('changeTracking');
+    expect(result.changeTracking?.diff?.text).toBe('@@ -1,1 +1,1 @@\n-old content\n+new content');
+    expect(result.changeTracking?.json?.title.previous).toBe('Old Title');
+    expect(result.changeTracking?.json?.title.current).toBe('New Title');
+  });
+});

package/src/index.ts

@@ -68,10 +68,31 @@ export interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult
   screenshot?: string;
   metadata?: FirecrawlDocumentMetadata;
   actions: ActionsSchema;
-  compare?: {
+  changeTracking?: {
     previousScrapeAt: string | null;
     changeStatus: "new" | "same" | "changed" | "removed";
     visibility: "visible" | "hidden";
+    diff?: {
+      text: string;
+      json: {
+        files: Array<{
+          from: string | null;
+          to: string | null;
+          chunks: Array<{
+            content: string;
+            changes: Array<{
+              type: string;
+              normal?: boolean;
+              ln?: number;
+              ln1?: number;
+              ln2?: number;
+              content: string;
+            }>;
+          }>;
+        }>;
+      };
+    };
+    json?: any;
   };
   // v1 search only
   title?: string;
@@ -83,7 +104,7 @@ export interface FirecrawlDocument<T = any, ActionsSchema extends (ActionsResult
  * Defines the options and configurations available for scraping web content.
  */
 export interface CrawlScrapeOptions {
-  formats?: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "screenshot@fullPage" | "extract" | "json" | "compare")[];
+  formats?: ("markdown" | "html" | "rawHtml" | "content" | "links" | "screenshot" | "screenshot@fullPage" | "extract" | "json" | "changeTracking")[];
   headers?: Record<string, string>;
   includeTags?: string[];
   excludeTags?: string[];
@@ -140,6 +161,11 @@ export interface ScrapeParams<LLMSchema extends zt.ZodSchema = any, ActionsSchem
     schema?: LLMSchema;
     systemPrompt?: string;
   }
+  changeTrackingOptions?: {
+    prompt?: string;
+    schema?: any;
+    modes?: ("json" | "git-diff")[];
+  }
   actions?: ActionsSchema;
 }