feat: Add support for additional step types (change, waitForElement) to API documentation and validation

Author: erdinccurebal

README.md

@@ -8,7 +8,7 @@ Req-Scrap is a RESTful API service that allows you to perform web scraping opera
 
 ## Features
 
-- **Step-Based Scraping**: Define your scraping workflow as a series of steps (navigate, click, wait, setViewport, etc.)
+- **Step-Based Scraping**: Define your scraping workflow as a series of steps (navigate, click, wait, setViewport, change, waitForElement, etc.)
 - **Speed Control**: Multiple speed modes to control execution pace (TURBO, FAST, NORMAL, SLOW, SLOWEST, CRAWL, STEALTH)
 - **Proxy Support**: Configure proxies with authentication for web requests
 - **Security**: Built-in basic authentication, helmet protection, and CORS configuration
@@ -105,6 +105,15 @@ Main endpoint for web scraping operations.
       "type": "setViewport",
       "width": 1366,
       "height": 768
+    },
+    {
+      "type": "change",
+      "selectors": [".search-input"],
+      "value": "example search"
+    },
+    {
+      "type": "waitForElement",
+      "selectors": [".search-results"]
     }
   ],
   "proxy": {

constants.js

@@ -162,12 +162,16 @@ export const AUTH_DEFAULTS = {
  * CLICK: Perform a click action
  * WAIT: Wait for a specified duration
  * SET_VIEWPORT: Set the browser viewport size
+ * CHANGE: Change the value of an input element
+ * WAIT_FOR_ELEMENT: Wait for a specific element to appear on the page
  */
 export const STEP_TYPES = {
   NAVIGATE: 'navigate',
   CLICK: 'click',
   WAIT: 'wait',
-  SET_VIEWPORT: 'setViewport'
+  SET_VIEWPORT: 'setViewport',
+  CHANGE: 'change',
+  WAIT_FOR_ELEMENT: 'waitForElement'
 };
 
 /**

helpers/validators.js

@@ -64,8 +64,15 @@ const scraperRequestSchema = Joi.object({
     // Array of steps to be executed by the scraper
     steps: Joi.array().items(
         Joi.object({
-            // Step type - artık tüm adım türlerini destekleyen genel bir string değeri
-            type: Joi.string(),
+            // Step type - specific allowed types only
+            type: Joi.string().valid(
+                STEP_TYPES.NAVIGATE,
+                STEP_TYPES.CLICK,
+                STEP_TYPES.WAIT,
+                STEP_TYPES.SET_VIEWPORT,
+                STEP_TYPES.CHANGE,
+                STEP_TYPES.WAIT_FOR_ELEMENT
+            ).required(),
 
             // Generic value field, used differently based on step type
             value: Joi.string().allow(''),

routes.js

@@ -267,7 +267,7 @@ router.get("/health", controllerHealth);
  *                     type:
  *                       type: string
  *                       description: Type of browser action
- *                       enum: [navigate, click, wait, setViewport]
+ *                       enum: [navigate, click, wait, setViewport, change, waitForElement]
  *                       example: "navigate"
  *                     url:
  *                       type: string
@@ -307,7 +307,8 @@ router.get("/health", controllerHealth);
  *                       example: "main"
  *                     value:
  *                       type: string
- *                       description: Generic value used by some step types
+ *                       description: Value to set for input fields (for change action)
+ *                       example: "search keyword"
  *                     offsetX:
  *                       type: number
  *                       description: X-coordinate offset for click operations
@@ -316,9 +317,66 @@ router.get("/health", controllerHealth);
  *                       type: number
  *                       description: Y-coordinate offset for click operations
  *                       example: 9
+ *                     frame:
+ *                       type: array
+ *                       description: Frame indices for nested frames
+ *                       items:
+ *                         type: number
+ *                       example: [0]
+ *                     duration:
+ *                       type: number
+ *                       description: Duration of action in milliseconds
+ *                       example: 50
+ *                     deviceType:
+ *                       type: string
+ *                       description: Type of device simulated for interaction
+ *                       example: "mouse"
+ *                     button:
+ *                       type: string
+ *                       description: Mouse button used for click
+ *                       example: "primary"
+ *                     timeout:
+ *                       type: number
+ *                       description: Timeout duration for the step in milliseconds
+ *                       example: 5000
+ *                     operator:
+ *                       type: string
+ *                       description: Comparison operator for waitForElement
+ *                       example: ">="
+ *                     count:
+ *                       type: number
+ *                       description: Element count for waitForElement
+ *                       example: 1
+ *                     visible:
+ *                       type: boolean
+ *                       description: Whether element should be visible for waitForElement
+ *                       example: true
+ *                     attributes:
+ *                       type: object
+ *                       description: Attributes to check for waitForElement
+ *                       example: {"attribute": "value"}
+ *                     properties:
+ *                       type: object
+ *                       description: Properties to check for waitForElement
+ *                       example: {}
  *                     assertedEvents:
  *                       type: array
  *                       description: Expected events after step execution
+ *                       items:
+ *                         type: object
+ *                         properties:
+ *                           type:
+ *                             type: string
+ *                             description: Type of event
+ *                             example: "navigation"
+ *                           url:
+ *                             type: string
+ *                             description: Expected URL after event
+ *                             example: "https://www.amazon.com/dp/B00IJ0ALYS"
+ *                           title:
+ *                             type: string
+ *                             description: Expected page title after event
+ *                             example: "Product Page"
  *     responses:
  *       200:
  *         description: Scraping completed successfully