artes 1.0.61 → 1.0.63

package/README.md

@@ -242,9 +242,12 @@ const { mouse, keyboard, frame, elementInteractions, page } = require("artes");
 - **Frame Actions:**  
   `frame.first()`
 
+- **API Actions:**  
+  `api.post(url, payload, requestDataType)`
+
 ---
 
-For a detailed explanation of each function, please refer to the [functionDefinitions.md](./docs/functionDefinitions.md).
+For a detailed explanation of each function, please refer to the [function definitions](./docs/functionDefinitions.md).
 
 ---
 
@@ -270,26 +273,39 @@ Then("User should see the login form", async () => {
 
 You can configure Artes by editing the `artes.config.js` file. Below are the default configuration options with explanations:
 
-| **Option**       | **Default Value**                                    | **Description**                     |
-| ---------------- | ---------------------------------------------------- | ----------------------------------- |
-| `headless`       | `true`                                               | Run in headless browser mode.       |
-| `paths`          | `["tests/features/"]`                                | Array of paths to feature files.    |
-| `pomPath`        | `"tests/POMs/*.json"`                                | Path to Page Object Models.         |
-| `steps`          | `"tests/steps/*.js"`                                 | string - Step definitions files.    |
-| `format`         | `["rerun:@rerun.txt", "allure-cucumberjs/reporter"]` | Array of formatter names/paths.     |
-| `formatOptions`  | `{ "resultsDir": "allure-result" }`                  | Formatter options.                  |
-| `parallel`       | `1`                                                  | Number of parallel workers.         |
-| `tags`           | `""`                                                 | Tag expression to filter scenarios. |
-| `language`       | `"en"`                                               | Default language for feature files. |
-| `order`          | `"defined"`                                          | Run order (defined or random).      |
-| `dryRun`         | `false`                                              | Prepare test run without execution. |
-| `failFast`       | `false`                                              | Stop on first failure.              |
-| `forceExit`      | `false`                                              | Force `process.exit()` after tests. |
-| `retry`          | `0`                                                  | Retry attempts for failing tests.   |
-| `retryTagFilter` | `""`                                                 | Tag expression for retries.         |
-| `strict`         | `true`                                               | Fail on pending steps.              |
-| `backtrace`      | `false`                                              | Show full backtrace for errors.     |
-| `publish`        | `false`                                              | Publish results to `cucumber.io`.   |
+
+| **Option**        | **Default Value**                                    | **Description**                                       |
+| ----------------- | ---------------------------------------------------- | ----------------------------------------------------- |
+| `timeout`         | `30`                                                 | Default timeout in milliseconds.                     |
+| `paths`           | `[moduleConfig.featuresPath]`                        | Paths to feature files.                              |
+| `require`         | `[moduleConfig.stepsPath, "src/stepDefinitions/*.js", "src/hooks/hooks.js"]` | Support code paths (CommonJS).      |
+| `pomPath`         | `moduleConfig.pomPath`                               | Path to Page Object Models.                          |
+| `import`          | `[]`                                                 | Support code paths.                                  |
+| `format`          | `["rerun:@rerun.txt", "allure-cucumberjs/reporter"]` | Formatter names/paths.                               |
+| `formatOptions`   | `{ "resultsDir": "allure-result" }`                  | Formatter options.                                   |
+| `parallel`        | `1`                                                  | Number of parallel workers.                          |
+| `dryRun`          | `false`                                              | Prepare test run without execution.                  |
+| `failFast`        | `false`                                              | Stop on first test failure.                         |
+| `forceExit`       | `false`                                              | Force `process.exit()` after tests.                 |
+| `strict`          | `true`                                               | Fail on pending steps.                              |
+| `backtrace`       | `false`                                              | Show full backtrace for errors.                     |
+| `tags`            | `""`                                                 | Tag expression to filter scenarios.                 |
+| `name`            | `[]`                                                 | Run scenarios matching regex.                        |
+| `order`           | `"defined"`                                          | Run order (defined/random).                         |
+| `language`        | `"en"`                                               | Default feature file language.                       |
+| `loader`          | `[]`                                                 | Module loader specifications.                        |
+| `requireModule`   | `[]`                                                 | Transpilation module names.                          |
+| `retry`           | `0`                                                  | Retry attempts for failing tests.                    |
+| `retryTagFilter`  | `""`                                                 | Tag expression for retries.                          |
+| `publish`         | `false`                                              | Publish to cucumber.io.                              |
+| `worldParameters` | `{}`                                                 | Custom world parameters.                             |
+
+### Environment Configuration
+
+| **Option**  | **Default Value** | **Description**                    |
+| ----------- | ----------------- | ---------------------------------- |
+| `env`       | `""`              | Environment configuration. Should match the name with the baseURL object, like "dev"       |
+| `baseURL`   | `""`              | Base URL for API requests. Can be object {"dev":"dev-api.com", "pre":"pre-api.com"}, or string "dev-api.com"       |
 
 ---
 

package/docs/functionDefinitions.md

@@ -3,7 +3,7 @@
 If you don't want to deal with Playwright methods directly, you can simply use the following predefined actions methods by import them:
 
 ```javascript
-const { mouse, keyboard, frame, elementInteractions, page } = require("artes");
+const { mouse, keyboard, frame, elementInteractions, page, api } = require("artes");
 ```
 
 - **Mouse Actions:**  
@@ -21,6 +21,9 @@ const { mouse, keyboard, frame, elementInteractions, page } = require("artes");
 - **Frame Actions:**  
   `frame.first()`
 
+- **API Actions:**  
+  `api.post(url, payload, requestDataType)`
+
 ---
 
 ## Table of Contents
@@ -30,6 +33,8 @@ const { mouse, keyboard, frame, elementInteractions, page } = require("artes");
 - [Assertions Functions](#assertions-functions)
 - [Page Functions](#page-functions)
 - [Frame Functions](#frame-functions)
+- [API Functions](#api-object-methods)
+- [Usage Examples](#usage-examples)
 
 ### **Mouse Functions**
 
@@ -440,7 +445,7 @@ await wait(time);
 
 ---
 
-### **Assertion Functions**
+### **Assertions Functions**
 
 #### `shouldBeAttached(selector)`
 
@@ -2099,3 +2104,240 @@ Returns elements with the specified `data-testid` attribute.
 ```javascript
 const element = await getByTestId("submit-button");
 ```
+
+## API Object Methods
+
+The `api` object provides methods for making HTTP requests with automatic URL resolution, payload processing, and response handling.
+
+### `api.get(url, payload)`
+
+Makes a GET request to the specified URL.
+
+**Parameters:**
+- `url` (string): The target URL (supports variable resolution)
+- `payload` (string, optional): JSON string containing headers and other request options
+
+**Returns:** Promise that resolves when the request completes
+
+**Example:**
+```javascript
+await api.get("https://api.example.com/users", JSON.stringify({
+  headers: { "Authorization": "Bearer {{token}}" }
+}));
+```
+
+### `api.head(url)`
+
+Makes a HEAD request to the specified URL.
+
+**Parameters:**
+- `url` (string): The target URL (supports variable resolution)
+
+**Returns:** Promise that resolves when the request completes
+
+**Example:**
+```javascript
+await api.head("https://api.example.com/status");
+```
+
+### `api.post(url, payload, requestDataType)`
+
+Makes a POST request to the specified URL.
+
+**Parameters:**
+- `url` (string): The target URL (supports variable resolution)
+- `payload` (string): JSON string containing headers, body, and other request options
+- `requestDataType` (string, optional): Request data type ("multipart" for form data, default for JSON)
+
+**Returns:** Promise that resolves when the request completes
+
+**Example:**
+```javascript
+// Regular POST request
+await api.post("https://api.example.com/users", JSON.stringify({
+  headers: { "Content-Type": "application/json" },
+  body: { name: "John", email: "john@example.com" }
+}));
+
+// Multipart form data
+await api.post("https://api.example.com/upload", JSON.stringify({
+  headers: {},
+  body: { file: "/path/to/file.pdf", description: "Document upload" }
+}), "multipart");
+```
+
+### `api.put(url, payload, requestDataType)`
+
+Makes a PUT request to the specified URL.
+
+**Parameters:**
+- `url` (string): The target URL (supports variable resolution)
+- `payload` (string): JSON string containing headers, body, and other request options
+- `requestDataType` (string, optional): Request data type ("multipart" for form data, default for JSON)
+
+**Returns:** Promise that resolves when the request completes
+
+**Example:**
+```javascript
+await api.put("https://api.example.com/users/{{userId}}", JSON.stringify({
+  headers: { "Content-Type": "application/json" },
+  body: { name: "Updated Name" }
+}));
+```
+
+### `api.patch(url, payload, requestDataType)`
+
+Makes a PATCH request to the specified URL.
+
+**Parameters:**
+- `url` (string): The target URL (supports variable resolution)
+- `payload` (string): JSON string containing headers, body, and other request options
+- `requestDataType` (string, optional): Request data type ("multipart" for form data, default for JSON)
+
+**Returns:** Promise that resolves when the request completes
+
+**Example:**
+```javascript
+await api.patch("https://api.example.com/users/{{userId}}", JSON.stringify({
+  headers: { "Content-Type": "application/json" },
+  body: { email: "newemail@example.com" }
+}));
+```
+
+### `api.delete(url, payload)`
+
+Makes a DELETE request to the specified URL.
+
+**Parameters:**
+- `url` (string): The target URL (supports variable resolution)
+- `payload` (string, optional): JSON string containing headers and other request options
+
+**Returns:** Promise that resolves when the request completes
+
+**Example:**
+```javascript
+await api.delete("https://api.example.com/users/{{userId}}", JSON.stringify({
+  headers: { "Authorization": "Bearer {{token}}" }
+}));
+```
+
+### `api.vars()`
+
+Returns the current context variables object.
+
+**Returns:** Object containing all stored variables
+
+**Example:**
+```javascript
+const currentVars = api.vars();
+console.log(currentVars); // { token: "abc123", userId: "user456" }
+```
+
+
+## Static Methods
+
+### `extractVarsFromResponse(vars, customVarName)`
+
+Extracts variables from the response body using dot notation paths.
+
+**Parameters:**
+- `vars` (string): Comma-separated list of dot notation paths (e.g., "user.id,user.name")
+- `customVarName` (string, optional): Custom variable name to use instead of auto-generated names
+
+**Behavior:**
+- Extracts values from `context.response.responseBody` using specified paths
+- Saves extracted values as variables using `saveVar()`
+- If `customVarName` is provided, uses it; otherwise generates camelCase names
+
+**Example:**
+```javascript
+// Response body: { user: { id: 123, profile: { name: "John" } } }
+extractVarsFromResponse("user.id,user.profile.name");
+// Creates variables: userId = 123, userProfileName = "John"
+
+extractVarsFromResponse("user.id", "currentUserId");
+// Creates variable: currentUserId = 123
+```
+
+### `saveVar(value, customName, path)`
+
+Saves a variable to the context with either a custom name or auto-generated camelCase name.
+
+**Parameters:**
+- `value` (any): The value to store
+- `customName` (string, optional): Custom variable name
+- `path` (string): Dot notation path used for auto-generating variable name
+
+**Behavior:**
+- If `customName` is provided, uses it as the variable name
+- Otherwise, converts dot notation path to camelCase (e.g., "user.profile.name" → "userProfileName")
+
+### `resolveVariable(template)`
+
+Resolves variable placeholders in template strings using the format `{{variableName}}`.
+
+**Parameters:**
+- `template` (string): Template string containing variable placeholders
+
+**Returns:** String with variables resolved, or original value if not a string
+
+**Example:**
+```javascript
+// Assuming context.vars = { userId: "123", token: "abc" }
+resolveVariable("https://api.example.com/users/{{userId}}")
+// Returns: "https://api.example.com/users/123"
+
+resolveVariable("Bearer {{token}}")
+// Returns: "Bearer abc"
+```
+
+## Usage Examples
+
+### Basic API Usage
+
+```javascript
+// Set up variables
+context.vars.baseUrl = "https://api.example.com";
+context.vars.token = "your-auth-token";
+
+// Make a GET request
+await api.get("{{baseUrl}}/users", JSON.stringify({
+  headers: { "Authorization": "Bearer {{token}}" }
+}));
+
+// Extract user ID from response
+extractVarsFromResponse("data.0.id", "firstUserId");
+
+// Use extracted variable in subsequent request
+await api.get("{{baseUrl}}/users/{{firstUserId}}/profile");
+```
+
+### File Upload Example
+
+```javascript
+await api.post("{{baseUrl}}/upload", JSON.stringify({
+  headers: { "Authorization": "Bearer {{token}}" },
+  body: {
+    file: "/path/to/document.pdf",
+    description: "Important document",
+    metadata: { type: "legal", priority: "high" }
+  }
+}), "multipart");
+```
+
+### Variable Extraction and Chaining
+
+```javascript
+// Login request
+await api.post("{{baseUrl}}/auth/login", JSON.stringify({
+  body: { username: "user@example.com", password: "password" }
+}));
+
+// Extract token from login response
+extractVarsFromResponse("access_token", "authToken");
+
+// Use token in protected endpoint
+await api.get("{{baseUrl}}/protected-data", JSON.stringify({
+  headers: { "Authorization": "Bearer {{authToken}}" }
+}));
+```

package/docs/stepDefinitions.md

@@ -6,13 +6,17 @@
 - [Keyboard Actions](#keyboard-actions)
 - [Page Actions](#page-actions)
 - [Frame Actions](#frame-actions)
+- [API Actions](#api-actions)
+- [Variable Management](#variable-management)
+- [Debugging / Console Output](#debugging--console-output)
+- [Generic HTTP Request](#generic-http-request)
 - [Assertions](#assertions)
 
 ---
 
-## Mouse Actions
+# Mouse Actions
 
-### Click Actions
+## Click Actions
 
 - User clicks `{string}`
 - User clicks `{string}` with force
@@ -24,7 +28,7 @@
 - User clicks `{string}` with button `{string}`
 - User clicks `{string}` with button `{string}` and force
 
-### Double Click Actions
+## Double Click Actions
 
 - User double clicks `{string}`
 - User double clicks `{string}` with force
@@ -34,70 +38,70 @@
 - User double clicks at `{int}, {int}` coordinates with click count `{int}` and delay `{int}`
 - User double clicks at `{int}, {int}` coordinates with force
 
-### Mouse Movement Actions
+## Mouse Movement Actions
 
 - User moves to `{int}, {int}` coordinates
 - User scrolls the mouse wheel at `{int}, {int}` coordinates
 
-### Hover Actions
+## Hover Actions
 
 - User hovers over `{string}`
 - User hovers over `{string}` with force
 - User hovers over `{string}` at `{int}, {int}` position
 - User hovers over `{string}` at `{int}, {int}` position with force
 
-### Focus Actions
+## Focus Actions
 
 - User focuses on `{string}`
 - User focuses on `{string}` with force
 - User focuses on `{string}` at `{int}, {int}` position
 - User focuses on `{string}` at `{int}, {int}` position with force
 
-### Drag Actions
+## Drag Actions
 
 - User drags `{string}` to `{string}`
 - User drags `{string}` to `{int}, {int}` position
 
-### Selection Actions
+## Selection Actions
 
 - User selects by value `{string}` from `{string}`
 - User selects by text `{string}` from `{string}`
 
-### Checkbox Actions
+## Checkbox Actions
 
 - User checks `{string}`
 - User unchecks `{string}`
 
-### Scroll Actions
+## Scroll Actions
 
 - User scrolls into view for `{string}`
 
 ---
 
-## Keyboard Actions
+# Keyboard Actions
 
-### Press Actions
+## Press Actions
 
-- User presses `{string} on {string}`
+- User presses `{string}` on `{string}`
 - User presses keys `{string}` sequentially on `{string}`
-- User presses keys `{string}` sequentially with delay `{int} on {string}`
+- User presses keys `{string}` sequentially with delay `{int}` on `{string}`
 
-### Input Actions
+## Input Actions
 
 - User types `{string}` in `{string}`
 - User types `{string}` with delay `{int}`
 - User inserts text `{string}`
 - User clears `{string}`
 
-### Selection Actions
+## Selection Actions
 
 - User selects text in `{string}`
 
-### File Input Actions
+## File Input Actions
 
 - User sets input files `{string}` for `{string}`
 
-### Key State Actions
+## Key State Actions
 
 - User holds down `{string}`
 - User releases `{string}`
@@ -105,19 +109,19 @@
 
 ---
 
-## Page Actions
+# Page Actions
 
-### Navigation Actions
+## Navigation Actions
 
 - User navigates to `{string}` page
 - User navigates previous page
 - User navigates next page
 
-### URL Actions
+## URL Actions
 
 - User gets URL of page
 
-### Wait Actions
+## Wait Actions
 
 - User waits `{int}` seconds
 - User waits `{int}` milliseconds
@@ -125,36 +129,113 @@
 
 ---
 
-## Frame Actions
+# Frame Actions
 
-### Screenshot Actions
+## Screenshot Actions
 
 - User takes a screenshot of `{string}`
 
-### Content and Locator Actions
+## Content and Locator Actions
 
 - User gets the content frame of `{string}`
 - User gets the frame locator of `{string}`
 
-### Element Retrieval Actions
+## Element Retrieval Actions
 
-- User gets the `{int}th` element of `{string}`
+- User gets the `{int} th` element of `{string}`
 - User gets the first element of `{string}`
 - User gets the last element of `{string}`
 - User filters elements of `{string}` with filter `{string}`
 
-### Counting Actions
+## Counting Actions
 
 - User counts the elements of `{string}`
 
-### Accessibility-Based Retrieval Actions
+## Accessibility-Based Retrieval Actions
 
 - User gets the element with alt text `{string}`
 - User gets the element with label `{string}`
 - User gets the element with placeholder `{string}`
 - User gets the element with role `{string}`
-- User gets the element with testI `{string}`
-- User gets the element with testII `{string}`
+- User gets the element with testId `{string}`
+- User gets the element with testId `{string}` (assuming you meant testId twice)
+
+---
+
+# API Actions
+
+## GET Requests
+
+- User sends GET request to `{string}`
+- User sends GET request to `{string}` with payload:
+- User sends GET request to `{string}` and saves `{string}` variables
+- User sends GET request to `{string}` with payload and saves `{string}` variables
+
+## HEAD Requests
+
+- User sends HEAD request to `{string}`
+
+## POST Requests
+
+- User sends POST request to `{string}` with payload:
+- User sends POST request to `{string}` with payload and saves `{string}` variables
+- User sends multipart POST request to `{string}` with payload:
+- User sends multipart POST request to `{string}` with payload and `{string}` variables
+
+## PUT Requests
+
+- User sends PUT request to `{string}` with payload:
+- User sends PUT request to `{string}` with payload and saves `{string}` variables
+- User sends multipart PUT request to `{string}` with payload:
+- User sends multipart PUT request to `{string}` with payload and saves `{string}` variables
+
+## PATCH Requests
+
+- User sends PATCH request to `{string}` with payload:
+- User sends PATCH request to `{string}` with payload and saves `{string}` variables
+- User sends multipart PATCH request to `{string}` with payload:
+- User sends multipart PATCH request to `{string}` with payload and saves `{string}` variables
+
+## DELETE Requests
+
+- User sends DELETE request to `{string}`
+- User sends DELETE request to `{string}` and saves `{string}` variables
+- User sends DELETE request to `{string}` with payload:
+- User sends DELETE request to `{string}` with payload and saves `{string}` variables
+
+---
+
+# Variable Management
+
+- User saves `{string}` variable from response as `{string}`
+- User saves `{string}` variable as `{string}`
+
+---
+
+# Debugging / Console Output
+
+- User wants to see saved variables
+- User wants to see request body
+- User wants to see response body
+
+---
+
+# Generic HTTP Request
+
+- User sends `{string}` request to `{string}`
+
+---
+
+# Random Data Generation
+
+- User sets random words as `{string}` variable
+- User sets random number from `{int}` to `{int}` as `{string}` variable
+
+# API Data Extraction
+
+- User sends GET request to `{string}` and save `{string}` variable as a `{string}` randomly
+
+---
 
 ## Assertions
 
@@ -267,3 +348,5 @@
 - User expects `{string}` should not contain `{string}` object properties
 - User expects `{string}` should not contain `{string}` substring
 - User expects `{string}` should not match `{string}` regex
+- User expects that request should have `{int}` status code
+- User expects that response body should match `{string}` schema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artes",
-  "version": "1.0.61",
+  "version": "1.0.63",
   "description": "The simplest way to automate UI and API tests using Cucumber-style steps.",
   "main": "index.js",
   "scripts": {

package/src/helper/stepFunctions/APIActions.js

@@ -87,10 +87,10 @@ async function responseMaker(request, response) {
 
   response && Object.assign(responseObject, { URL: response.url() });
 
-  request.headers &&
+  request?.headers &&
     Object.assign(responseObject, { "Request Headers": await request.headers });
 
-  request.body &&
+  request?.body &&
     Object.assign(responseObject, { "Request Body": await request.body });
 
   response && Object.assign(responseObject, { Response: await response });

package/src/helper/stepFunctions/browserActions.js

@@ -1,7 +1,9 @@
-const { context, selector } = require("../imports/commons");
+const { context, selector, resolveVariable } = require("../imports/commons");
 
 const browser = {
   setCookies: async (cookies) => {
+    cookies = await resolveVariable(cookies);
+
     let cookieData;
     try {
       cookieData = JSON.parse(cookies);

package/src/helper/stepFunctions/keyboardActions.js

@@ -1,21 +1,25 @@
-const { element } = require("../imports/commons");
+const { element, resolveVariable } = require("../imports/commons");
 
 const keyboard = {
   press: async (selector, key) => {
+    key = await resolveVariable(key);
     await element(selector).press(key);
   },
   pressSequentially: async (selector, keys) => {
+    keys = await resolveVariable(keys);
     await element(selector).pressSequentially(keys);
   },
   pressSequentiallyDelay: async (selector, keys, delay) => {
+    keys = await resolveVariable(keys);
     await element(selector).pressSequentially(keys, { delay: delay });
   },
   fill: async (selector, value) => {
+    value = await resolveVariable(value);
     value !== "" ? await element(selector).fill(value) : "";
   },
   multipleElementFill: async (selectors, value) => {
     const elementCount = await frame.count(selectors);
-
+    value = await resolveVariable(value);
     for (let i = 0; i < elementCount; i++) {
       await frame.nth(selectors, i).fill(value);
     }
@@ -27,6 +31,7 @@ const keyboard = {
     await element(selector).selectText();
   },
   setInputFiles: async (selector, files) => {
+    files = await resolveVariable(files);
     await element(selector).setInputFiles(files);
   },
 };

package/src/stepDefinitions/API.steps.js

@@ -176,11 +176,11 @@ When("User wants to see saved variables", async function () {
 });
 
 When("User wants to see request body", async function () {
-  console.log("Request Body: ", context.response.requestBody);
+  console.log("Request Body: ", context.response["Request Body"]);
 });
 
 When("User wants to see response body", async function () {
-  console.log("Request Body: ", context.response.responseBody);
+  console.log("Request Body: ", context.response["Response Body"]);
 });
 
 When(
@@ -225,7 +225,7 @@ When(
 When(
   "User expects that request should have {int} status code",
   async function (expectedStatusCode) {
-    const actualStatusCode = await context.response.response.status();
+    const actualStatusCode = await context.response.Response.status();
     expect(actualStatusCode).toBe(expectedStatusCode);
   },
 );

package/src/stepDefinitions/frameActions.steps.js

@@ -18,7 +18,7 @@ When("User gets the frame locator of {string}", async function (selector) {
 
 // User gets the nth element of a specific selector
 When(
-  "User gets the {int}th element of {string}",
+  "User gets the {int} th element of {string}",
   async function (index, selector) {
     await frame.nth(selector, index);
   },