codeceptjs 3.6.4-beta.2 → 3.6.4

package/lib/ai.js

@@ -31,6 +31,36 @@ const defaultPrompts = {
         Here is HTML code of a page where the failure has happened: \n\n${html}`,
     }];
   },
+
+  generatePageObject: (html, extraPrompt = '', rootLocator = null) => [{
+    role: 'user',
+    content: `As a test automation engineer I am creating a Page Object for a web application using CodeceptJS.
+        Here is an sample page object:
+
+const { I } = inject();
+
+module.exports = {
+
+  // setting locators
+  element1: '#selector',
+  element2: '.selector',
+  element3: locate().withText('text'),
+
+  // seting methods
+  doSomethingOnPage(params) {
+    // ...
+  },  
+}        
+
+        I want to generate a Page Object for the page I provide.
+        Write JavaScript code in similar manner to list all locators on the page.
+        Use locators in order of preference: by text (use locate().withText()), label, CSS, XPath.
+        Avoid TailwindCSS, Bootstrap or React style formatting classes in locators.
+        Add methods to to interact with page when needed.
+        ${extraPrompt}
+        ${rootLocator ? `All provided elements are inside '${rootLocator}'. Declare it as root variable and for every locator use locate(...).inside(root)` : ''}
+        Add only locators from this HTML: \n\n${html}`,
+  }],
 };
 
 class AiAssistant {
@@ -182,10 +212,26 @@ class AiAssistant {
     return this.config.response(response);
   }
 
+  /**
+   *
+   * @param {*} extraPrompt
+   * @param {*} locator
+   * @returns
+   */
+  async generatePageObject(extraPrompt = null, locator = null) {
+    if (!this.isEnabled) return [];
+    if (!this.minifiedHtml) throw new Error('No HTML context provided');
+
+    const response = await this.createCompletion(this.prompts.generatePageObject(this.minifiedHtml, locator, extraPrompt));
+    if (!response) return [];
+
+    return this.config.response(response);
+  }
+
   calculateTokens(messages) {
     // we implement naive approach for calculating tokens with no extra requests
     // this approach was tested via https://platform.openai.com/tokenizer
-    // we need it to display current usage tokens usage so users could analyze effectiveness of AI
+    // we need it to display current tokens usage so users could analyze effectiveness of AI
 
     const inputString = messages.map(m => m.content).join(' ').trim();
     const numWords = (inputString.match(/[^\s\-:=]+/g) || []).length;

package/lib/helper/AI.js

@@ -1,8 +1,14 @@
 const Helper = require('@codeceptjs/helper');
+const ora = require('ora-classic');
+const fs = require('fs');
+const path = require('path');
 const ai = require('../ai');
 const standardActingHelpers = require('../plugin/standardActingHelpers');
 const Container = require('../container');
 const { splitByChunks, minifyHtml } = require('../html');
+const { beautify } = require('../utils');
+const output = require('../output');
+const { registerVariable } = require('../pause');
 
 /**
  * AI Helper for CodeceptJS.
@@ -10,6 +16,8 @@ const { splitByChunks, minifyHtml } = require('../html');
  * This helper class provides integration with the AI GPT-3.5 or 4 language model for generating responses to questions or prompts within the context of web pages. It allows you to interact with the GPT-3.5 model to obtain intelligent responses based on HTML fragments or general prompts.
  * This helper should be enabled with any web helpers like Playwright or Puppeteer or WebDrvier to ensure the HTML context is available.
  *
+ * Use it only in development mode. It is recommended to run it only inside pause() mode.
+ *
  * ## Configuration
  *
  * This helper should be configured in codecept.json or codecept.conf.js
@@ -66,9 +74,9 @@ class AI extends Helper {
 
       if (htmlChunks.length > 1) messages.push({ role: 'user', content: 'If action is not possible on this page, do not propose anything, I will send another HTML fragment' });
 
-      const response = await this.aiAssistant.createCompletion(messages);
+      const response = await this._processAIRequest(messages);
 
-      console.log(response);
+      output.print(response);
 
       responses.push(response);
     }
@@ -96,15 +104,15 @@ class AI extends Helper {
       { role: 'user', content: `Within this HTML: ${minifyHtml(html)}` },
     ];
 
-    const response = await this.aiAssistant.createCompletion(messages);
+    const response = await this._processAIRequest(messages);
 
-    console.log(response);
+    output.print(response);
 
     return response;
   }
 
   /**
-   * Send a general request to ChatGPT and return response.
+   * Send a general request to AI and return response.
    * @param {string} prompt
    * @returns {Promise<string>} - A Promise that resolves to the generated response from the GPT model.
    */
@@ -113,10 +121,79 @@ class AI extends Helper {
       { role: 'user', content: prompt },
     ];
 
-    const response = await this.aiAssistant.createCompletion(messages);
+    const response = await this._processAIRequest(messages);
+
+    output.print(response);
+
+    return response;
+  }
+
+  /**
+   * Generates PageObject for current page using AI.
+   *
+   * It saves the PageObject to the output directory. You can review the page object and adjust it as needed and move to pages directory.
+   * Prompt can be customized in a global config file.
+   *
+   * ```js
+   * // create page object for whole page
+   * I.askForPageObject('home');
+   *
+   * // create page object with extra prompt
+   * I.askForPageObject('home', 'implement signIn(username, password) method');
+   *
+   * // create page object for a specific element
+   * I.askForPageObject('home', null, '.detail');
+   * ```
+   *
+   * Asks for a page object based on the provided page name, locator, and extra prompt.
+   *
+   * @async
+   * @param {string} pageName - The name of the page to retrieve the object for.
+   * @param {string|null} [extraPrompt=null] - An optional extra prompt for additional context or information.
+   * @param {string|null} [locator=null] - An optional locator to find a specific element on the page.
+   * @returns {Promise<Object>} A promise that resolves to the requested page object.
+   */
+  async askForPageObject(pageName, extraPrompt = null, locator = null) {
+    const html = locator ? await this.helper.grabHTMLFrom(locator) : await this.helper.grabSource();
+
+    const spinner = ora(' Processing AI request...').start();
+    await this.aiAssistant.setHtmlContext(html);
+    const response = await this.aiAssistant.generatePageObject(extraPrompt, locator);
+    spinner.stop();
+
+    if (!response[0]) {
+      output.error('No response from AI');
+      return '';
+    }
+
+    const code = beautify(response[0]);
 
-    console.log(response);
+    output.print('----- Generated PageObject ----');
+    output.print(code);
+    output.print('-------------------------------');
 
+    const fileName = path.join(output_dir, `${pageName}Page-${Date.now()}.js`);
+
+    output.print(output.styles.bold(`Page object for ${pageName} is saved to ${output.styles.bold(fileName)}`));
+    fs.writeFileSync(fileName, code);
+
+    try {
+      registerVariable('page', require(fileName));
+      output.success('Page object registered for this session as `page` variable');
+      output.print('Use `=>page.methodName()` in shell to run methods of page object');
+      output.print('Use `click(page.locatorName)` to check locators of page object');
+    } catch (err) {
+      output.error('Error while registering page object');
+      output.error(err.message);
+    }
+
+    return code;
+  }
+
+  async _processAIRequest(messages) {
+    const spinner = ora(' Processing AI request...').start();
+    const response = await this.aiAssistant.createCompletion(messages);
+    spinner.stop();
     return response;
   }
 }

package/lib/helper/REST.js

@@ -1,5 +1,6 @@
 const axios = require('axios').default;
 const Helper = require('@codeceptjs/helper');
+const { Agent } = require('https');
 const Secret = require('../secret');
 
 const { beautify } = require('../utils');
@@ -14,6 +15,7 @@ const { beautify } = require('../utils');
  * @prop {boolean} [printCurl=false] - print cURL request on console logs. False by default.
  * @prop {number} [timeout=1000] - timeout for requests in milliseconds. 10000ms by default.
  * @prop {object} [defaultHeaders] - a list of default headers.
+ * @prop {object} [httpAgent] - create an agent with SSL certificate
  * @prop {function} [onRequest] - an async function which can update request object.
  * @prop {function} [onResponse] - an async function which can update response object.
  * @prop {number} [maxUploadFileSize] - set the max content file size in MB when performing api calls.
@@ -42,6 +44,25 @@ const config = {};
  *}
  * ```
  *
+ *  With httpAgent
+ *
+ * ```js
+ * {
+ *   helpers: {
+ *     REST: {
+ *       endpoint: 'http://site.com/api',
+ *       prettyPrintJson: true,
+ *       httpAgent: {
+ *          key: fs.readFileSync(__dirname + '/path/to/keyfile.key'),
+ *          cert: fs.readFileSync(__dirname + '/path/to/certfile.cert'),
+ *          rejectUnauthorized: false,
+ *          keepAlive: true
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
  * ## Access From Helpers
  *
  * Send REST requests by accessing `_executeRequest` method:
@@ -77,7 +98,14 @@ class REST extends Helper {
     this._setConfig(config);
 
     this.headers = { ...this.options.defaultHeaders };
-    this.axios = axios.create();
+
+    // Create an agent with SSL certificate
+    if (this.options.httpAgent) {
+      if (!this.options.httpAgent.key || !this.options.httpAgent.cert) throw Error('Please recheck your httpAgent config!');
+      this.httpsAgent = new Agent(this.options.httpAgent);
+    }
+
+    this.axios = this.httpsAgent ? axios.create({ httpsAgent: this.httpsAgent }) : axios.create();
     // @ts-ignore
     this.axios.defaults.headers = this.options.defaultHeaders;
   }
@@ -166,7 +194,9 @@ class REST extends Helper {
     }
 
     this.options.prettyPrintJson ? this.debugSection('Request', beautify(JSON.stringify(_debugRequest))) : this.debugSection('Request', JSON.stringify(_debugRequest));
-    if (this.options.printCurl) this.debugSection('CURL Request', curlize(request));
+    if (this.options.printCurl) {
+      this.debugSection('CURL Request', curlize(request));
+    }
 
     let response;
     try {
@@ -349,6 +379,7 @@ class REST extends Helper {
 module.exports = REST;
 
 function curlize(request) {
+  if (request.data?.constructor.name.toLowerCase() === 'formdata') return 'cURL is not printed as the request body is not a JSON';
   let curl = `curl --location --request ${request.method ? request.method.toUpperCase() : 'GET'} ${request.baseURL} `.replace("'", '');
 
   if (request.headers) {

package/lib/history.js

@@ -10,6 +10,9 @@ const output = require('./output');
  */
 class ReplHistory {
   constructor() {
+    if (global.output_dir) {
+      this.historyFile = path.join(global.output_dir, 'cli-history');
+    }
     this.commands = [];
   }
 
@@ -21,16 +24,26 @@ class ReplHistory {
     this.commands.pop();
   }
 
+  load() {
+    if (!this.historyFile) return;
+    if (!fs.existsSync(this.historyFile)) {
+      return;
+    }
+
+    const history = fs.readFileSync(this.historyFile, 'utf-8');
+    return history.split('\n').reverse().filter(line => line.startsWith('I.')).map(line => line.slice(2));
+  }
+
   save() {
+    if (!this.historyFile) return;
     if (this.commands.length === 0) {
       return;
     }
 
-    const historyFile = path.join(global.output_dir, 'cli-history');
     const commandSnippet = `\n\n<<< Recorded commands on ${new Date()}\n${this.commands.join('\n')}`;
-    fs.appendFileSync(historyFile, commandSnippet);
+    fs.appendFileSync(this.historyFile, commandSnippet);
 
-    output.print(colors.yellow(` Commands have been saved to ${historyFile}`));
+    output.print(colors.yellow(` Commands have been saved to ${this.historyFile}`));
 
     this.commands = [];
   }

package/lib/pause.js

@@ -56,7 +56,15 @@ function pauseSession(passedObject = {}) {
       output.print(colors.blue(' Ideas: ask it to fill forms for you or to click'));
     }
   }
-  rl = readline.createInterface(process.stdin, process.stdout, completer);
+
+  rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+    terminal: true,
+    completer,
+    history: history.load(),
+    historySize: 50, // Adjust the history size as needed
+  });
 
   rl.on('line', parseInput);
   rl.on('close', () => {
@@ -105,7 +113,7 @@ async function parseInput(cmd) {
     if (cmd.trim().startsWith('=>')) {
       isCustomCommand = true;
       cmd = cmd.trim().substring(2, cmd.length);
-    } else if (aiAssistant.isEnabled && !cmd.match(/^\w+\(/) && cmd.includes(' ')) {
+    } else if (aiAssistant.isEnabled && cmd.trim() && !cmd.match(/^\w+\(/) && cmd.includes(' ')) {
       const currentOutputLevel = output.level();
       output.level(0);
       const res = I.grabSource();
@@ -121,7 +129,7 @@ async function parseInput(cmd) {
           output.level(currentOutputLevel);
         }
 
-        const spinner = ora("Processing OpenAI request...").start();
+        const spinner = ora("Processing AI request...").start();
         cmd = await aiAssistant.writeSteps(cmd);
         spinner.stop();
         output.print('');
@@ -200,4 +208,10 @@ function completer(line) {
   return [hits && hits.length ? hits : completions, line];
 }
 
+function registerVariable(name, value) {
+  registeredVariables[name] = value;
+}
+
 module.exports = pause;
+
+module.exports.registerVariable = registerVariable;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.4-beta.2",
+  "version": "3.6.4",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -72,14 +72,14 @@
     "@codeceptjs/helper": "2.0.4",
     "@cucumber/cucumber-expressions": "17",
     "@cucumber/gherkin": "26",
-    "@cucumber/messages": "24.1.0",
+    "@cucumber/messages": "25.0.1",
     "@xmldom/xmldom": "0.8.10",
     "acorn": "8.11.3",
     "arrify": "2.0.1",
     "axios": "1.7.2",
     "chai": "5.1.1",
     "chai-deep-match": "1.2.1",
-    "chai-exclude": "2.1.0",
+    "chai-exclude": "2.1.1",
     "chai-json-schema": "1.5.1",
     "chai-json-schema-ajv": "5.2.4",
     "chai-match-pattern": "1.3.0",
@@ -179,4 +179,4 @@
       "strict": false
     }
   }
-}
+}

package/typings/index.d.ts

@@ -44,6 +44,44 @@ declare namespace CodeceptJS {
     Scenario: number;
   };
 
+  type AiPrompt = {
+    role: string;
+    content: string;
+  }
+
+  type AiConfig = {
+    /** request function to send prompts to AI provider */
+    request: (messages: any) => Promise<string>,
+
+    /** custom prompts */
+    prompts?: {
+      /** Returns prompt to write CodeceptJS steps inside pause mode  */
+      writeStep?: (html: string, input: string) => Array<AiPrompt>;
+      /** Returns prompt to heal step when test fails on CI if healing is on  */
+      healStep?: (html: string, object) => Array<AiPrompt>;
+      /** Returns prompt to generate page object inside pause mode  */
+      generatePageObject?: (html: string, extraPrompt?: string, rootLocator?: string) => Array<AiPrompt>;
+    },
+
+    /** max tokens to use */
+    maxTokens?: number,
+
+
+    /** configuration for processing HTML for GPT */
+    html?: {
+      /** max size of HTML to be sent to OpenAI to avoid token limit */
+      maxLength?: number,
+      /** should HTML be changed by removing non-interactive elements */
+      simplify?: boolean,
+      /** should HTML be minified before sending */
+      minify?: boolean,
+      interactiveElements?: Array<string>,
+      textElements?: Array<string>,
+      allowedAttrs?: Array<string>,
+      allowedRoles?: Array<string>,
+    }
+  }
+
   type MainConfig = {
     /** Pattern to locate CodeceptJS tests.
      * Allows to enter glob pattern or an Array<string> of patterns to match tests / test file names.
@@ -165,6 +203,9 @@ declare namespace CodeceptJS {
        */
       JSONResponse?: any;
 
+      /** Enable AI features for development purposes */
+      AI?: any;
+
       [key: string]: any;
     },
     /**
@@ -353,25 +394,7 @@ declare namespace CodeceptJS {
     /**
      * [AI](https://codecept.io/ai/) features configuration.
      */
-    ai?: {
-      /** OpenAI model to use */
-      model?: string,
-      /** temperature, measure of randomness. Lower is better. */
-      temperature?: number,
-      /** configuration for processing HTML for GPT */
-      html?: {
-        /** max size of HTML to be sent to OpenAI to avoid token limit */
-        maxLength?: number,
-        /** should HTML be changed by removing non-interactive elements */
-        simplify?: boolean,
-        /** should HTML be minified before sending */
-        minify?: boolean,
-        interactiveElements?: Array<string>,
-        textElements?: Array<string>,
-        allowedAttrs?: Array<string>,
-        allowedRoles?: Array<string>,
-      }
-    },
+    ai?: AiConfig,
 
     /**
      * Enable full promise-based helper methods for [TypeScript](https://codecept.io/typescript/) project.

package/typings/promiseBasedTypes.d.ts

@@ -5,6 +5,8 @@ declare namespace CodeceptJS {
      * This helper class provides integration with the AI GPT-3.5 or 4 language model for generating responses to questions or prompts within the context of web pages. It allows you to interact with the GPT-3.5 model to obtain intelligent responses based on HTML fragments or general prompts.
      * This helper should be enabled with any web helpers like Playwright or Puppeteer or WebDrvier to ensure the HTML context is available.
      *
+     * Use it only in development mode. It is recommended to run it only inside pause() mode.
+     *
      * ## Configuration
      *
      * This helper should be configured in codecept.json or codecept.conf.js
@@ -34,10 +36,34 @@ declare namespace CodeceptJS {
          */
         askGptOnPageFragment(prompt: string, locator: string): Promise<string>;
         /**
-         * Send a general request to ChatGPT and return response.
+         * Send a general request to AI and return response.
          * @returns - A Promise that resolves to the generated response from the GPT model.
          */
         askGptGeneralPrompt(prompt: string): Promise<string>;
+        /**
+         * Generates PageObject for current page using AI.
+         *
+         * It saves the PageObject to the output directory. You can review the page object and adjust it as needed and move to pages directory.
+         * Prompt can be customized in a global config file.
+         *
+         * ```js
+         * // create page object for whole page
+         * I.askForPageObject('home');
+         *
+         * // create page object with extra prompt
+         * I.askForPageObject('home', 'implement signIn(username, password) method');
+         *
+         * // create page object for a specific element
+         * I.askForPageObject('home', null, '.detail');
+         * ```
+         *
+         * Asks for a page object based on the provided page name, locator, and extra prompt.
+         * @param pageName - The name of the page to retrieve the object for.
+         * @param [extraPrompt = null] - An optional extra prompt for additional context or information.
+         * @param [locator = null] - An optional locator to find a specific element on the page.
+         * @returns A promise that resolves to the requested page object.
+         */
+        askForPageObject(pageName: string, extraPrompt?: string | null, locator?: string | null): Promise<object>;
     }
     /**
      * Helper for managing remote data using REST API.
@@ -1154,7 +1180,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1266,7 +1291,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1938,7 +1962,6 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2063,7 +2086,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -8189,6 +8211,25 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     *  With httpAgent
+     *
+     * ```js
+     * {
+     *   helpers: {
+     *     REST: {
+     *       endpoint: 'http://site.com/api',
+     *       prettyPrintJson: true,
+     *       httpAgent: {
+     *          key: fs.readFileSync(__dirname + '/path/to/keyfile.key'),
+     *          cert: fs.readFileSync(__dirname + '/path/to/certfile.cert'),
+     *          rejectUnauthorized: false,
+     *          keepAlive: true
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     *
      * ## Access From Helpers
      *
      * Send REST requests by accessing `_executeRequest` method:

package/typings/types.d.ts

@@ -5,6 +5,8 @@ declare namespace CodeceptJS {
      * This helper class provides integration with the AI GPT-3.5 or 4 language model for generating responses to questions or prompts within the context of web pages. It allows you to interact with the GPT-3.5 model to obtain intelligent responses based on HTML fragments or general prompts.
      * This helper should be enabled with any web helpers like Playwright or Puppeteer or WebDrvier to ensure the HTML context is available.
      *
+     * Use it only in development mode. It is recommended to run it only inside pause() mode.
+     *
      * ## Configuration
      *
      * This helper should be configured in codecept.json or codecept.conf.js
@@ -34,10 +36,34 @@ declare namespace CodeceptJS {
          */
         askGptOnPageFragment(prompt: string, locator: string): Promise<string>;
         /**
-         * Send a general request to ChatGPT and return response.
+         * Send a general request to AI and return response.
          * @returns - A Promise that resolves to the generated response from the GPT model.
          */
         askGptGeneralPrompt(prompt: string): Promise<string>;
+        /**
+         * Generates PageObject for current page using AI.
+         *
+         * It saves the PageObject to the output directory. You can review the page object and adjust it as needed and move to pages directory.
+         * Prompt can be customized in a global config file.
+         *
+         * ```js
+         * // create page object for whole page
+         * I.askForPageObject('home');
+         *
+         * // create page object with extra prompt
+         * I.askForPageObject('home', 'implement signIn(username, password) method');
+         *
+         * // create page object for a specific element
+         * I.askForPageObject('home', null, '.detail');
+         * ```
+         *
+         * Asks for a page object based on the provided page name, locator, and extra prompt.
+         * @param pageName - The name of the page to retrieve the object for.
+         * @param [extraPrompt = null] - An optional extra prompt for additional context or information.
+         * @param [locator = null] - An optional locator to find a specific element on the page.
+         * @returns A promise that resolves to the requested page object.
+         */
+        askForPageObject(pageName: string, extraPrompt?: string | null, locator?: string | null): Promise<object>;
     }
     /**
      * Helper for managing remote data using REST API.
@@ -1178,7 +1204,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1290,7 +1315,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1965,7 +1989,6 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2090,7 +2113,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -8686,6 +8708,7 @@ declare namespace CodeceptJS {
      * @property [printCurl = false] - print cURL request on console logs. False by default.
      * @property [timeout = 1000] - timeout for requests in milliseconds. 10000ms by default.
      * @property [defaultHeaders] - a list of default headers.
+     * @property [httpAgent] - create an agent with SSL certificate
      * @property [onRequest] - an async function which can update request object.
      * @property [onResponse] - an async function which can update response object.
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
@@ -8696,6 +8719,7 @@ declare namespace CodeceptJS {
         printCurl?: boolean;
         timeout?: number;
         defaultHeaders?: any;
+        httpAgent?: any;
         onRequest?: (...params: any[]) => any;
         onResponse?: (...params: any[]) => any;
         maxUploadFileSize?: number;
@@ -8722,6 +8746,25 @@ declare namespace CodeceptJS {
      * }
      * ```
      *
+     *  With httpAgent
+     *
+     * ```js
+     * {
+     *   helpers: {
+     *     REST: {
+     *       endpoint: 'http://site.com/api',
+     *       prettyPrintJson: true,
+     *       httpAgent: {
+     *          key: fs.readFileSync(__dirname + '/path/to/keyfile.key'),
+     *          cert: fs.readFileSync(__dirname + '/path/to/certfile.cert'),
+     *          rejectUnauthorized: false,
+     *          keepAlive: true
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     *
      * ## Access From Helpers
      *
      * Send REST requests by accessing `_executeRequest` method: