Merge pull request #68 from mdp/mdp/dotenv_jest

[Bugfix] JS-SDK: Remove dotenv and add tests

apps/js-sdk/firecrawl/jest.config.cjs

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

apps/js-sdk/firecrawl/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@mendable/firecrawl-js",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "JavaScript SDK for Firecrawl API",
   "main": "build/index.js",
   "types": "types/index.d.ts",
   "type": "module",
   "scripts": {
     "build": "tsc",
-    "publish":"npm run build && npm publish --access public",
+    "publish": "npm run build && npm publish --access public",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest src/**/*.test.ts"
   },
   "repository": {
     "type": "git",
@@ -17,17 +17,18 @@
   "author": "Mendable.ai",
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.6.8",
+    "axios": "^1.6.8"
-    "dotenv": "^16.4.5"
   },
   "bugs": {
     "url": "https://github.com/mendableai/firecrawl/issues"
   },
   "homepage": "https://github.com/mendableai/firecrawl#readme",
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
     "@types/axios": "^0.14.0",
-    "@types/dotenv": "^8.2.0",
     "@types/node": "^20.12.7",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
     "typescript": "^5.4.5"
   },
   "keywords": [

apps/js-sdk/firecrawl/src/__tests__/index.test.ts

@@ -0,0 +1,48 @@
+import { describe, test, expect, jest } from '@jest/globals';
+import axios from 'axios';
+import FirecrawlApp from '../index';
+
+import { readFile } from 'fs/promises';
+import { join } from 'path';
+
+// Mock jest and set the type
+jest.mock('axios');
+const mockedAxios = axios as jest.Mocked<typeof axios>;
+
+// Get the fixure data from the JSON file in ./fixtures
+async function loadFixture(name: string): Promise<string> {
+  return await readFile(join(__dirname, 'fixtures', `${name}.json`), 'utf-8')
+}
+
+describe('the firecrawl JS SDK', () => {
+
+  test('Should require an API key to instantiate FirecrawlApp', async () => {
+    const fn = () => {
+      new FirecrawlApp({ apiKey: undefined });
+    };
+    expect(fn).toThrow('No API key provided');
+  });
+
+  test('Should return scraped data from a /scrape API call', async () => {
+    const mockData = await loadFixture('scrape');
+    mockedAxios.post.mockResolvedValue({
+      status: 200,
+      data: JSON.parse(mockData),
+    });
+
+    const apiKey = 'YOUR_API_KEY'
+    const app = new FirecrawlApp({ apiKey });
+    // Scrape a single URL
+    const url = 'https://mendable.ai';
+    const scrapedData = await app.scrapeUrl(url);
+
+    expect(mockedAxios.post).toHaveBeenCalledTimes(1);
+    expect(mockedAxios.post).toHaveBeenCalledWith(
+      expect.stringMatching(/^https:\/\/api.firecrawl.dev/),
+      expect.objectContaining({ url }),
+      expect.objectContaining({ headers: expect.objectContaining({'Authorization': `Bearer ${apiKey}`}) }),
+    )
+    expect(scrapedData.success).toBe(true);
+    expect(scrapedData.data.metadata.title).toEqual('Mendable');
+  });
+})

apps/js-sdk/firecrawl/src/index.ts

@@ -1,6 +1,4 @@
 import axios, { AxiosResponse, AxiosRequestHeaders } from 'axios';
-import dotenv from 'dotenv';
-dotenv.config();
 
 /**
  * Configuration interface for FirecrawlApp.
@@ -65,7 +63,7 @@ export default class FirecrawlApp {
    * @param {FirecrawlAppConfig} config - Configuration options for the FirecrawlApp instance.
    */
   constructor({ apiKey = null }: FirecrawlAppConfig) {
-    this.apiKey = apiKey || process.env.FIRECRAWL_API_KEY || '';
+    this.apiKey = apiKey || '';
     if (!this.apiKey) {
       throw new Error('No API key provided');
     }
@@ -267,4 +265,4 @@ export default class FirecrawlApp {
       throw new Error(`Unexpected error occurred while trying to ${action}. Status code: ${response.status}`);
     }
   }
-}
+}