Merge pull request #57 from ScrapeGraphAI/mock-info

VinciGit00 · web-flow · commit 2af54073f34e · 2025-09-01T14:27:29.000+02:00
Mock info
diff --git a/scrapegraph-js/examples/mock_mode_example.js b/scrapegraph-js/examples/mock_mode_example.js
@@ -33,7 +33,7 @@ import {
   agenticScraper,
   getAgenticScraperRequest,
   getCredits,
-  submitFeedback
+  sendFeedback
 } from '../index.js';
 
 import { 
@@ -77,9 +77,9 @@ async function basicMockUsage() {
     const credits = await getCredits(API_KEY);
     console.log('Credits:', credits);
     
-    // Test submitFeedback endpoint
-    console.log('\n-- Testing submitFeedback endpoint --');
-    const feedback = await submitFeedback(API_KEY, 'mock-request-id', 5, 'Great service!');
+    // Test sendFeedback endpoint
+    console.log('\n-- Testing sendFeedback endpoint --');
+    const feedback = await sendFeedback(API_KEY, 'mock-request-id', 5, 'Great service!');
     console.log('Feedback result:', feedback);
     
   } catch (error) {
@@ -242,8 +242,8 @@ async function testAllEndpoints() {
     const credits = await getCredits(API_KEY);
     console.log('GetCredits:', credits.remaining_credits ? '✅' : '❌');
     
-    const feedback = await submitFeedback(API_KEY, 'mock-id', 5, 'Great!');
-    console.log('SubmitFeedback:', feedback.status ? '✅' : '❌');
+    const feedback = await sendFeedback(API_KEY, 'mock-id', 5, 'Great!');
+    console.log('SendFeedback:', feedback.status ? '✅' : '❌');
     
   } catch (error) {
     console.error('Error testing endpoints:', error.message);
diff --git a/scrapegraph-js/src/agenticScraper.js b/scrapegraph-js/src/agenticScraper.js
@@ -1,5 +1,7 @@
 import axios from 'axios';
 import handleError from './utils/handleError.js';
+import { isMockEnabled, getMockConfig } from './utils/mockConfig.js';
+import { getMockResponse } from './utils/mockResponse.js';
 
 /**
  * Perform automated browser actions on a webpage using AI-powered agentic scraping.
@@ -11,6 +13,8 @@ import handleError from './utils/handleError.js';
  * @param {string} [userPrompt=null] - Prompt for AI extraction (required when aiExtraction=true)
  * @param {Object} [outputSchema=null] - Schema for structured data extraction (optional, used with aiExtraction=true)
  * @param {boolean} [aiExtraction=false] - Whether to use AI for data extraction from the scraped content
+ * @param {Object} options - Optional configuration options
+ * @param {boolean} options.mock - Override mock mode for this request
  * @returns {Promise<Object>} Response from the API containing request_id and initial status
  * @throws {Error} Will throw an error in case of an HTTP failure or invalid parameters.
  *
@@ -60,7 +64,19 @@ import handleError from './utils/handleError.js';
  *   console.error('Error:', error.message);
  * }
  */
-export async function agenticScraper(apiKey, url, steps, useSession = true, userPrompt = null, outputSchema = null, aiExtraction = false) {
+export async function agenticScraper(apiKey, url, steps, useSession = true, userPrompt = null, outputSchema = null, aiExtraction = false, options = {}) {
+  const { mock = null } = options;
+
+  // Check if mock mode is enabled
+  const useMock = mock !== null ? mock : isMockEnabled();
+  
+  if (useMock) {
+    console.log('🧪 Mock mode active. Returning stub for agenticScraper request');
+    const mockConfig = getMockConfig();
+    const mockData = getMockResponse('POST', 'https://api.scrapegraphai.com/v1/agentic-scrapper', mockConfig.customResponses, mockConfig.customHandler);
+    return mockData;
+  }
+
   const endpoint = 'https://api.scrapegraphai.com/v1/agentic-scrapper';
   const headers = {
     'accept': 'application/json',
@@ -166,7 +182,19 @@ export async function agenticScraper(apiKey, url, steps, useSession = true, user
  * allowing for complex interactions like form filling, clicking buttons,
  * and navigating through multi-step workflows with session management.
  */
-export async function getAgenticScraperRequest(apiKey, requestId) {
+export async function getAgenticScraperRequest(apiKey, requestId, options = {}) {
+  const { mock = null } = options;
+
+  // Check if mock mode is enabled
+  const useMock = mock !== null ? mock : isMockEnabled();
+  
+  if (useMock) {
+    console.log('🧪 Mock mode active. Returning stub for getAgenticScraperRequest');
+    const mockConfig = getMockConfig();
+    const mockData = getMockResponse('GET', `https://api.scrapegraphai.com/v1/agentic-scrapper/${requestId}`, mockConfig.customResponses, mockConfig.customHandler);
+    return mockData;
+  }
+
   const endpoint = 'https://api.scrapegraphai.com/v1/agentic-scrapper/' + requestId;
   const headers = {
     'accept': 'application/json',
diff --git a/scrapegraph-js/src/crawl.js b/scrapegraph-js/src/crawl.js
@@ -2,6 +2,8 @@ import axios from 'axios';
 import handleError from './utils/handleError.js';
 import { ZodType } from 'zod';
 import { zodToJsonSchema } from 'zod-to-json-schema';
+import { isMockEnabled, getMockConfig } from './utils/mockConfig.js';
+import { getMockResponse } from './utils/mockResponse.js';
 
 /**
  * Start a crawl job using the ScrapeGraphAI API.
@@ -18,6 +20,7 @@ import { zodToJsonSchema } from 'zod-to-json-schema';
  * @param {boolean} [options.sameDomainOnly=true] - Whether to only crawl pages from the same domain
  * @param {boolean} [options.sitemap] - Whether to use sitemap for better page discovery
  * @param {number} [options.batchSize=1] - Batch size for processing pages (1-10)
+ * @param {boolean} [options.mock] - Override mock mode for this request
  * @returns {Promise<Object>} The crawl job response
  * @throws {Error} Throws an error if the HTTP request fails
  */
@@ -28,6 +31,17 @@ export async function crawl(
   schema,
   options = {}
 ) {
+  const { mock = null } = options;
+
+  // Check if mock mode is enabled
+  const useMock = mock !== null ? mock : isMockEnabled();
+  
+  if (useMock) {
+    console.log('🧪 Mock mode active. Returning stub for crawl request');
+    const mockConfig = getMockConfig();
+    const mockData = getMockResponse('POST', 'https://api.scrapegraphai.com/v1/crawl', mockConfig.customResponses, mockConfig.customHandler);
+    return mockData;
+  }
   const endpoint = 'https://api.scrapegraphai.com/v1/crawl';
   const headers = {
     'accept': 'application/json',
@@ -81,7 +95,19 @@ export async function crawl(
  * @returns {Promise<Object>} The crawl result
  * @throws {Error} Throws an error if the HTTP request fails
  */
-export async function getCrawlRequest(apiKey, crawlId) {
+export async function getCrawlRequest(apiKey, crawlId, options = {}) {
+  const { mock = null } = options;
+
+  // Check if mock mode is enabled
+  const useMock = mock !== null ? mock : isMockEnabled();
+  
+  if (useMock) {
+    console.log('🧪 Mock mode active. Returning stub for getCrawlRequest');
+    const mockConfig = getMockConfig();
+    const mockData = getMockResponse('GET', `https://api.scrapegraphai.com/v1/crawl/${crawlId}`, mockConfig.customResponses, mockConfig.customHandler);
+    return mockData;
+  }
+
   const endpoint = `https://api.scrapegraphai.com/v1/crawl/${crawlId}`;
   const headers = {
     'accept': 'application/json',
diff --git a/scrapegraph-js/src/feedback.js b/scrapegraph-js/src/feedback.js
@@ -1,5 +1,7 @@
 import axios from 'axios';
 import handleError from './utils/handleError.js';
+import { isMockEnabled, getMockConfig } from './utils/mockConfig.js';
+import { getMockResponse } from './utils/mockResponse.js';
 
 /**
  * Send feedback to the API.
@@ -8,9 +10,23 @@ import handleError from './utils/handleError.js';
  * @param {string} requestId - The request ID associated with the feedback
  * @param {number} rating - The rating score
  * @param {string} feedbackText - Optional feedback message to send
+ * @param {Object} options - Optional configuration options
+ * @param {boolean} options.mock - Override mock mode for this request
  * @returns {Promise<string>} Response from the API in JSON format
  */
-export async function sendFeedback(apiKey, requestId, rating, feedbackText = null) {
+export async function sendFeedback(apiKey, requestId, rating, feedbackText = null, options = {}) {
+  const { mock = null } = options;
+
+  // Check if mock mode is enabled
+  const useMock = mock !== null ? mock : isMockEnabled();
+  
+  if (useMock) {
+    console.log('🧪 Mock mode active. Returning stub for sendFeedback request');
+    const mockConfig = getMockConfig();
+    const mockData = getMockResponse('POST', 'https://api.scrapegraphai.com/v1/feedback', mockConfig.customResponses, mockConfig.customHandler);
+    return mockData;
+  }
+
   const endpoint = 'https://api.scrapegraphai.com/v1/feedback';
   const headers = {
     'accept': 'application/json',
diff --git a/scrapegraph-js/src/markdownify.js b/scrapegraph-js/src/markdownify.js
@@ -1,15 +1,31 @@
 import axios from 'axios';
 import handleError from './utils/handleError.js';
+import { isMockEnabled, getMockConfig } from './utils/mockConfig.js';
+import { getMockResponse } from './utils/mockResponse.js';
 
 /**
  * Converts a webpage into clean, well-structured markdown format.
  *
  * @param {string} apiKey - Your ScrapeGraph AI API key.
  * @param {string} url - The URL of the webpage to be converted.
+ * @param {Object} options - Optional configuration options.
+ * @param {boolean} options.mock - Override mock mode for this request
  * @returns {Promise<string>} A promise that resolves to the markdown representation of the webpage.
  * @throws {Error} Throws an error if the HTTP request fails.
  */
-export async function markdownify(apiKey, url) {
+export async function markdownify(apiKey, url, options = {}) {
+  const { mock = null } = options;
+
+  // Check if mock mode is enabled
+  const useMock = mock !== null ? mock : isMockEnabled();
+  
+  if (useMock) {
+    console.log('🧪 Mock mode active. Returning stub for markdownify request');
+    const mockConfig = getMockConfig();
+    const mockData = getMockResponse('POST', 'https://api.scrapegraphai.com/v1/markdownify', mockConfig.customResponses, mockConfig.customHandler);
+    return mockData;
+  }
+
   const endpoint = 'https://api.scrapegraphai.com/v1/markdownify';
   const headers = {
     'accept': 'application/json',
@@ -66,7 +82,19 @@ export async function markdownify(apiKey, url) {
  *   - Links and images
  *   - Text formatting (bold, italic, etc.)
  */
-export async function getMarkdownifyRequest(apiKey, requestId) {
+export async function getMarkdownifyRequest(apiKey, requestId, options = {}) {
+  const { mock = null } = options;
+
+  // Check if mock mode is enabled
+  const useMock = mock !== null ? mock : isMockEnabled();
+  
+  if (useMock) {
+    console.log('🧪 Mock mode active. Returning stub for getMarkdownifyRequest');
+    const mockConfig = getMockConfig();
+    const mockData = getMockResponse('GET', `https://api.scrapegraphai.com/v1/markdownify/${requestId}`, mockConfig.customResponses, mockConfig.customHandler);
+    return mockData;
+  }
+
   const endpoint = 'https://api.scrapegraphai.com/v1/markdownify/' + requestId;
   const headers = {
     'accept': 'application/json',
diff --git a/scrapegraph-js/src/searchScraper.js b/scrapegraph-js/src/searchScraper.js
@@ -2,6 +2,8 @@ import axios from 'axios';
 import handleError from './utils/handleError.js';
 import { ZodType } from 'zod';
 import { zodToJsonSchema } from 'zod-to-json-schema';
+import { isMockEnabled, getMockConfig } from './utils/mockConfig.js';
+import { getMockResponse } from './utils/mockResponse.js';
 
 /**
  * Search and extract information from multiple web sources using AI.
@@ -13,10 +15,23 @@ import { zodToJsonSchema } from 'zod-to-json-schema';
  *                                 Credit calculation: 30 base + 10 per additional website beyond 3.
  * @param {Object} [schema] - Optional schema object defining the output structure
  * @param {String} userAgent - the user agent like "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36"
+ * @param {Object} options - Optional configuration options
+ * @param {boolean} options.mock - Override mock mode for this request
  * @returns {Promise<string>} Extracted data in JSON format matching the provided schema
  * @throws - Will throw an error in case of an HTTP failure.
  */
-export async function searchScraper(apiKey, prompt, numResults = 3, schema = null, userAgent = null) {
+export async function searchScraper(apiKey, prompt, numResults = 3, schema = null, userAgent = null, options = {}) {
+  const { mock = null } = options;
+
+  // Check if mock mode is enabled
+  const useMock = mock !== null ? mock : isMockEnabled();
+  
+  if (useMock) {
+    console.log('🧪 Mock mode active. Returning stub for searchScraper request');
+    const mockConfig = getMockConfig();
+    const mockData = getMockResponse('POST', 'https://api.scrapegraphai.com/v1/searchscraper', mockConfig.customResponses, mockConfig.customHandler);
+    return mockData;
+  }
   const endpoint = 'https://api.scrapegraphai.com/v1/searchscraper';
   const headers = {
     'accept': 'application/json',
@@ -92,7 +107,19 @@ export async function searchScraper(apiKey, prompt, numResults = 3, schema = nul
  * information based on the original search query. The results are structured according to
  * the schema provided in the original searchScraper call, if any.
  */
-export async function getSearchScraperRequest(apiKey, requestId) {
+export async function getSearchScraperRequest(apiKey, requestId, options = {}) {
+  const { mock = null } = options;
+
+  // Check if mock mode is enabled
+  const useMock = mock !== null ? mock : isMockEnabled();
+  
+  if (useMock) {
+    console.log('🧪 Mock mode active. Returning stub for getSearchScraperRequest');
+    const mockConfig = getMockConfig();
+    const mockData = getMockResponse('GET', `https://api.scrapegraphai.com/v1/searchscraper/${requestId}`, mockConfig.customResponses, mockConfig.customHandler);
+    return mockData;
+  }
+
   const endpoint = 'https://api.scrapegraphai.com/v1/searchscraper/' + requestId;
   const headers = {
     'accept': 'application/json',
