codeceptjs 3.6.2 → 3.6.3-beta.3

package/README.md

@@ -315,8 +315,8 @@ Thanks all to those who are and will have contributing to this awesome project!
 <a href="https://github.com/VikalpP"><img src="https://avatars.githubusercontent.com/u/11846339?v=4" title="VikalpP" width="80" height="80"></a>
 <a href="https://github.com/elaichenkov"><img src="https://avatars.githubusercontent.com/u/29764053?v=4" title="elaichenkov" width="80" height="80"></a>
 <a href="https://github.com/BorisOsipov"><img src="https://avatars.githubusercontent.com/u/6514276?v=4" title="BorisOsipov" width="80" height="80"></a>
-<a href="https://github.com/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
 <a href="https://github.com/nitschSB"><img src="https://avatars.githubusercontent.com/u/39341455?v=4" title="nitschSB" width="80" height="80"></a>
+<a href="https://github.com/hubidu"><img src="https://avatars.githubusercontent.com/u/13134082?v=4" title="hubidu" width="80" height="80"></a>
 <a href="https://github.com/jploskonka"><img src="https://avatars.githubusercontent.com/u/669483?v=4" title="jploskonka" width="80" height="80"></a>
 <a href="https://github.com/ngraf"><img src="https://avatars.githubusercontent.com/u/7094389?v=4" title="ngraf" width="80" height="80"></a>
 <a href="https://github.com/maojunxyz"><img src="https://avatars.githubusercontent.com/u/28778042?v=4" title="maojunxyz" width="80" height="80"></a>

package/lib/cli.js

@@ -186,20 +186,24 @@ class Cli extends Base {
           }
         }
 
-        let stack = err.stack ? err.stack.split('\n') : [];
-        if (stack[0] && stack[0].includes(err.message)) {
-          stack.shift();
-        }
+        try {
+          let stack = err.stack ? err.stack.split('\n') : [];
+          if (stack[0] && stack[0].includes(err.message)) {
+            stack.shift();
+          }
 
-        if (output.level() < 3) {
-          stack = stack.slice(0, 3);
-        }
+          if (output.level() < 3) {
+            stack = stack.slice(0, 3);
+          }
 
-        err.stack = `${stack.join('\n')}\n\n${output.colors.blue(log)}`;
+          err.stack = `${stack.join('\n')}\n\n${output.colors.blue(log)}`;
 
-        // clone err object so stack trace adjustments won't affect test other reports
-        test.err = err;
-        return test;
+          // clone err object so stack trace adjustments won't affect test other reports
+          test.err = err;
+          return test;
+        } catch (e) {
+          throw Error(e);
+        }
       });
 
       const originalLog = Base.consoleLog;

package/lib/command/gherkin/init.js

@@ -4,7 +4,7 @@ const mkdirp = require('mkdirp');
 const output = require('../../output');
 const { fileExists } = require('../../utils');
 const {
-  getConfig, getTestRoot, updateConfig, safeFileWrite,
+  getConfig, getTestRoot, updateConfig, safeFileWrite, findConfigFile,
 } = require('../utils');
 
 const featureFile = `Feature: Business rules
@@ -26,7 +26,17 @@ Given('I have a defined step', () => {
 
 module.exports = function (genPath) {
   const testsPath = getTestRoot(genPath);
+  const configFile = findConfigFile(testsPath);
+
+  if (!configFile) {
+    output.error(
+      "Can't initialize Gherkin. This command must be run in an already initialized project.",
+    );
+    process.exit(1);
+  }
+
   const config = getConfig(testsPath);
+  const extension = path.extname(configFile).substring(1);
 
   output.print('Initializing Gherkin (Cucumber BDD) for CodeceptJS');
   output.print('--------------------------');
@@ -53,18 +63,18 @@ module.exports = function (genPath) {
     output.success(`Created ${dir}, place step definitions into it`);
   }
 
-  if (safeFileWrite(path.join(dir, 'steps.js'), stepsFile)) {
-    output.success('Created sample steps file: step_definitions/steps.js');
+  if (safeFileWrite(path.join(dir, `steps.${extension}`), stepsFile)) {
+    output.success(
+      `Created sample steps file: step_definitions/steps.${extension}`,
+    );
   }
 
   config.gherkin = {
-    features: './features/*.feature',
-    steps: [
-      './step_definitions/steps.js',
-    ],
+    features: "./features/*.feature",
+    steps: [`./step_definitions/steps.${extension}`],
   };
 
-  updateConfig(testsPath, config);
+  updateConfig(testsPath, config, extension);
 
   output.success('Gherkin setup is done.');
   output.success('Start writing feature files and implement corresponding steps.');

package/lib/command/utils.js

@@ -41,15 +41,15 @@ function fail(msg) {
 
 module.exports.fail = fail;
 
-function updateConfig(testsPath, config, key, extension = 'js') {
+function updateConfig(testsPath, config, extension) {
   const configFile = path.join(testsPath, `codecept.conf.${extension}`);
   if (!fileExists(configFile)) {
-    console.log();
     const msg = `codecept.conf.${extension} config can\'t be updated automatically`;
+    console.log();
     console.log(`${output.colors.bold.red(msg)}`);
-    console.log('Please update it manually:');
+    console.log(`${output.colors.bold.red('Please update it manually:')}`);
     console.log();
-    console.log(`${key}: ${config[key]}`);
+    console.log(config);
     console.log();
     return;
   }
@@ -104,3 +104,14 @@ module.exports.createOutputDir = (config, testRoot) => {
     mkdirp.sync(outputDir);
   }
 };
+
+module.exports.findConfigFile = (testsPath) => {
+  const extensions = ['js', 'ts'];
+  for (const ext of extensions) {
+    const configFile = path.join(testsPath, `codecept.conf.${ext}`);
+    if (fileExists(configFile)) {
+      return configFile;
+    }
+  }
+  return null;
+};

package/lib/helper/{Expect.js → ExpectHelper.js}

@@ -23,7 +23,7 @@ import('chai').then(chai => {
  *{
  *   helpers: {
  *     Playwright: {...},
- *     Expect: {},
+ *     ExpectHelper: {},
  *   }
  *}
  * ```

package/lib/helper/Playwright.js

@@ -1981,7 +1981,7 @@ class Playwright extends Helper {
    */
   async dontSeeCookie(name) {
     const cookies = await this.browserContext.cookies();
-    empty(`cookie ${name} to be set`).assert(cookies.filter(c => c.name === name));
+    empty(`cookie ${name} not to be set`).assert(cookies.filter(c => c.name === name));
   }
 
   /**

package/lib/helper/Puppeteer.js

@@ -1627,7 +1627,7 @@ class Puppeteer extends Helper {
    */
   async dontSeeCookie(name) {
     const cookies = await this.page.cookies();
-    empty(`cookie ${name} to be set`).assert(cookies.filter(c => c.name === name));
+    empty(`cookie ${name} not to be set`).assert(cookies.filter(c => c.name === name));
   }
 
   /**
@@ -2472,12 +2472,12 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * Mocks network request using [`Request Interception`](https://pptr.dev/next/guides/request-interception)
+   * Mocks network request using [`Request Interception`](https://pptr.dev/guides/network-interception)
    *
    * ```js
    * I.mockRoute(/(\.png$)|(\.jpg$)/, route => route.abort());
    * ```
-   * This method allows intercepting and mocking requests & responses. [Learn more about it](https://pptr.dev/next/guides/request-interception)
+   * This method allows intercepting and mocking requests & responses. [Learn more about it](https://pptr.dev/guides/network-interception)
    *
    * @param {string|RegExp} [url] URL, regex or pattern for to match URL
    * @param {function} [handler] a function to process request

package/lib/helper/WebDriver.js

@@ -642,6 +642,7 @@ class WebDriver extends Helper {
 
     if (this.options.automationProtocol) {
       this.puppeteerBrowser = await this.browser.getPuppeteer();
+      this.page = (await this.puppeteerBrowser.pages())[0];
     }
 
     return this.browser;
@@ -2731,7 +2732,6 @@ class WebDriver extends Helper {
     this.recording = true;
     this.recordedAtLeastOnce = true;
 
-    this.page = (await this.puppeteerBrowser.pages())[0];
     await this.page.setRequestInterception(true);
 
     this.page.on('request', (request) => {

package/lib/plugin/coverage.js

@@ -11,7 +11,7 @@ const defaultConfig = {
   outputDir: 'output/coverage',
 };
 
-const supportedHelpers = ['Puppeteer', 'Playwright'];
+const supportedHelpers = ['Puppeteer', 'Playwright', 'WebDriver'];
 
 const v8CoverageHelpers = {
   Playwright: {
@@ -61,6 +61,33 @@ const v8CoverageHelpers = {
       await coverageReport.add(coverageList);
     },
   },
+  WebDriver: {
+    startCoverage: async (page) => {
+      await Promise.all([
+        page.coverage.startJSCoverage({
+          resetOnNavigation: false,
+          includeRawScriptCoverage: true,
+        }),
+        page.coverage.startCSSCoverage({
+          resetOnNavigation: false,
+        }),
+      ]);
+    },
+    takeCoverage: async (page, coverageReport) => {
+      const [jsCoverage, cssCoverage] = await Promise.all([
+        page.coverage.stopJSCoverage(),
+        page.coverage.stopCSSCoverage(),
+      ]);
+      // to raw V8 script coverage
+      const coverageList = [...jsCoverage.map((it) => {
+        return {
+          source: it.text,
+          ...it.rawScriptCoverage,
+        };
+      }), ...cssCoverage];
+      await coverageReport.add(coverageList);
+    },
+  },
 };
 
 /**
@@ -109,11 +136,17 @@ module.exports = function (config) {
   const debug = debugModule(`codeceptjs:plugin:${helperName.toLowerCase()}Coverage`);
 
   const helper = helpers[helperName];
+
+  if (helperName === 'WebDriver' && !helper.config.devtoolsProtocol) throw Error('Coverage is currently supporting the WebDriver running with Devtools protocol.');
+
   const v8Helper = v8CoverageHelpers[helperName];
 
   const coverageOptions = {
     ...config,
   };
+
+  if (helperName === 'WebDriver') coverageOptions.coverageProvider = 'v8';
+
   const coverageReport = new CoverageReport(coverageOptions);
   coverageReport.cleanCache();
 

package/lib/plugin/retryTo.js

@@ -1,5 +1,4 @@
 const recorder = require('../recorder');
-const store = require('../store');
 const { debug } = require('../output');
 
 const defaultConfig = {
@@ -73,49 +72,58 @@ const defaultConfig = {
  * const retryTo = codeceptjs.container.plugins('retryTo');
  * ```
  *
-*/
+ */
 module.exports = function (config) {
   config = Object.assign(defaultConfig, config);
+  function retryTo(callback, maxTries, pollInterval = config.pollInterval) {
+    return new Promise((done, reject) => {
+      let tries = 1;
 
-  if (config.registerGlobal) {
-    global.retryTo = retryTo;
-  }
-  return retryTo;
+      function handleRetryException(err) {
+        recorder.throw(err);
+        reject(err);
+      }
 
-  function retryTo(callback, maxTries, pollInterval = undefined) {
-    let tries = 1;
-    if (!pollInterval) pollInterval = config.pollInterval;
-
-    let err = null;
-
-    return new Promise((done) => {
       const tryBlock = async () => {
+        tries++;
         recorder.session.start(`retryTo ${tries}`);
-        await callback(tries);
+        try {
+          await callback(tries);
+        } catch (err) {
+          handleRetryException(err);
+        }
+
+        // Call done if no errors
         recorder.add(() => {
           recorder.session.restore(`retryTo ${tries}`);
           done(null);
         });
-        recorder.session.catch((e) => {
-          err = e;
+
+        // Catch errors and retry
+        recorder.session.catch((err) => {
           recorder.session.restore(`retryTo ${tries}`);
-          tries++;
           if (tries <= maxTries) {
             debug(`Error ${err}... Retrying`);
-            err = null;
-
-            recorder.add(`retryTo ${tries}`, () => setTimeout(tryBlock, pollInterval));
+            recorder.add(`retryTo ${tries}`, () =>
+              setTimeout(tryBlock, pollInterval)
+            );
           } else {
-            done(null);
+            // if maxTries reached
+            handleRetryException(err);
           }
         });
       };
 
-      recorder.add('retryTo', async () => {
-        tryBlock();
+      recorder.add('retryTo', tryBlock).catch(err => {
+        console.error('An error occurred:', err);
+        done(null);
       });
-    }).then(() => {
-      if (err) recorder.throw(err);
     });
   }
+
+  if (config.registerGlobal) {
+    global.retryTo = retryTo;
+  }
+
+  return retryTo;
 };

package/lib/scenario.js

@@ -18,6 +18,16 @@ const injectHook = function (inject, suite) {
   return recorder.promise();
 };
 
+function makeDoneCallableOnce(done) {
+  let called = false;
+  return function (err) {
+    if (called) {
+      return;
+    }
+    called = true;
+    return done(err);
+  };
+}
 /**
  * Wraps test function, injects support objects from container,
  * starts promise chain with recorder, performs before/after hooks
@@ -34,15 +44,17 @@ module.exports.test = (test) => {
   test.async = true;
 
   test.fn = function (done) {
+    const doneFn = makeDoneCallableOnce(done);
     recorder.errHandler((err) => {
       recorder.session.start('teardown');
       recorder.cleanAsyncErr();
-      if (test.throws) { // check that test should actually fail
+      if (test.throws) {
+        // check that test should actually fail
         try {
           assertThrown(err, test.throws);
           event.emit(event.test.passed, test);
           event.emit(event.test.finished, test);
-          recorder.add(() => done());
+          recorder.add(doneFn);
           return;
         } catch (newErr) {
           err = newErr;
@@ -50,40 +62,26 @@ module.exports.test = (test) => {
       }
       event.emit(event.test.failed, test, err);
       event.emit(event.test.finished, test);
-      recorder.add(() => done(err));
+      recorder.add(() => doneFn(err));
     });
 
     if (isAsyncFunction(testFn)) {
       event.emit(event.test.started, test);
-
-      const catchError = e => {
-        recorder.throw(e);
-        recorder.catch((e) => {
-          const err = (recorder.getAsyncErr() === null) ? e : recorder.getAsyncErr();
-          recorder.session.start('teardown');
-          recorder.cleanAsyncErr();
-          event.emit(event.test.failed, test, err);
-          event.emit(event.test.finished, test);
-          recorder.add(() => done(err));
+      testFn
+        .call(test, getInjectedArguments(testFn, test))
+        .then(() => {
+          recorder.add('fire test.passed', () => {
+            event.emit(event.test.passed, test);
+            event.emit(event.test.finished, test);
+          });
+          recorder.add('finish test', doneFn);
+        })
+        .catch((err) => {
+          recorder.throw(err);
+        })
+        .finally(() => {
+          recorder.catch();
         });
-      };
-
-      let injectedArguments;
-      try {
-        injectedArguments = getInjectedArguments(testFn, test);
-      } catch (e) {
-        catchError(e);
-        return;
-      }
-
-      testFn.call(test, injectedArguments).then(() => {
-        recorder.add('fire test.passed', () => {
-          event.emit(event.test.passed, test);
-          event.emit(event.test.finished, test);
-        });
-        recorder.add('finish test', () => done());
-        recorder.catch();
-      }).catch(catchError);
       return;
     }
 
@@ -97,7 +95,7 @@ module.exports.test = (test) => {
         event.emit(event.test.passed, test);
         event.emit(event.test.finished, test);
       });
-      recorder.add('finish test', () => done());
+      recorder.add('finish test', doneFn);
       recorder.catch();
     }
   };
@@ -109,13 +107,14 @@ module.exports.test = (test) => {
  */
 module.exports.injected = function (fn, suite, hookName) {
   return function (done) {
+    const doneFn = makeDoneCallableOnce(done);
     const errHandler = (err) => {
       recorder.session.start('teardown');
       recorder.cleanAsyncErr();
       event.emit(event.test.failed, suite, err);
       if (hookName === 'after') event.emit(event.test.after, suite);
       if (hookName === 'afterSuite') event.emit(event.suite.after, suite);
-      recorder.add(() => done(err));
+      recorder.add(() => doneFn(err));
     };
 
     recorder.errHandler((err) => {
@@ -137,28 +136,32 @@ module.exports.injected = function (fn, suite, hookName) {
     const opts = suite.opts || {};
     const retries = opts[`retry${ucfirst(hookName)}`] || 0;
 
-    promiseRetry(async (retry, number) => {
-      try {
-        recorder.startUnlessRunning();
-        await fn.call(this, getInjectedArguments(fn));
-        await recorder.promise().catch(err => retry(err));
-      } catch (err) {
-        retry(err);
-      } finally {
-        if (number < retries) {
-          recorder.stop();
-          recorder.start();
+    promiseRetry(
+      async (retry, number) => {
+        try {
+          recorder.startUnlessRunning();
+          await fn.call(this, getInjectedArguments(fn));
+          await recorder.promise().catch((err) => retry(err));
+        } catch (err) {
+          retry(err);
+        } finally {
+          if (number < retries) {
+            recorder.stop();
+            recorder.start();
+          }
         }
-      }
-    }, { retries })
+      },
+      { retries },
+    )
       .then(() => {
         recorder.add('fire hook.passed', () => event.emit(event.hook.passed, suite));
-        recorder.add(`finish ${hookName} hook`, () => done());
+        recorder.add(`finish ${hookName} hook`, doneFn);
         recorder.catch();
-      }).catch((e) => {
+      })
+      .catch((e) => {
         recorder.throw(e);
         recorder.catch((e) => {
-          const err = (recorder.getAsyncErr() === null) ? e : recorder.getAsyncErr();
+          const err = recorder.getAsyncErr() === null ? e : recorder.getAsyncErr();
           errHandler(err);
         });
         recorder.add('fire hook.failed', () => event.emit(event.hook.failed, suite, e));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.2",
+  "version": "3.6.3-beta.3",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -76,8 +76,8 @@
     "@xmldom/xmldom": "0.8.10",
     "acorn": "8.11.3",
     "arrify": "2.0.1",
-    "axios": "1.6.7",
-    "chai": "5.1.0",
+    "axios": "1.7.2",
+    "chai": "5.1.1",
     "chai-deep-match": "1.2.1",
     "chai-exclude": "2.1.0",
     "chai-json-schema": "1.5.1",
@@ -89,7 +89,7 @@
     "cross-spawn": "7.0.3",
     "css-to-xpath": "0.1.0",
     "csstoxpath": "1.6.0",
-    "devtools": "8.33.1",
+    "devtools": "8.38.2",
     "envinfo": "7.11.1",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
@@ -104,10 +104,10 @@
     "lodash.merge": "4.6.2",
     "mkdirp": "1.0.4",
     "mocha": "10.4.0",
-    "monocart-coverage-reports": "2.7.4",
+    "monocart-coverage-reports": "2.8.3",
     "ms": "2.1.3",
     "ora-classic": "5.4.2",
-    "pactum": "3.6.7",
+    "pactum": "3.6.9",
     "parse-function": "5.6.10",
     "parse5": "7.1.2",
     "promise-retry": "1.1.1",
@@ -116,7 +116,7 @@
     "uuid": "9.0"
   },
   "optionalDependencies": {
-    "@codeceptjs/detox-helper": "1.0.5"
+    "@codeceptjs/detox-helper": "1.0.7"
   },
   "devDependencies": {
     "@codeceptjs/mock-request": "0.3.1",
@@ -131,40 +131,40 @@
     "@wdio/utils": "8.36.1",
     "@xmldom/xmldom": "0.8.10",
     "apollo-server-express": "2.25.3",
-    "chai-as-promised": "7.1.1",
+    "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "contributor-faces": "1.1.0",
     "documentation": "12.3.0",
-    "electron": "30.0.1",
-    "eslint": "8.56.0",
+    "electron": "30.1.0",
+    "eslint": "8.57.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-mocha": "6.3.0",
+    "eslint-plugin-mocha": "10.4.3",
     "expect": "29.7.0",
     "express": "4.19.2",
     "graphql": "14.6.0",
     "husky": "8.0.3",
     "inquirer-test": "2.0.1",
-    "jsdoc": "3.6.11",
+    "jsdoc": "4.0.3",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.10.1",
-    "playwright": "1.43.1",
-    "puppeteer": "22.6.3",
+    "playwright": "1.44.1",
+    "puppeteer": "22.10.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "0.9.3",
-    "sinon": "17.0.1",
+    "sinon": "18.0.0",
     "sinon-chai": "3.7.0",
     "testcafe": "3.5.0",
     "ts-morph": "21.0.1",
     "ts-node": "10.9.2",
     "tsd": "^0.31.0",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.25.12",
-    "typedoc-plugin-markdown": "3.17.1",
-    "typescript": "5.3.3",
+    "typedoc": "0.25.13",
+    "typedoc-plugin-markdown": "4.0.3",
+    "typescript": "5.4.5",
     "wdio-docker-service": "1.5.0",
-    "webdriverio": "8.36.1",
+    "webdriverio": "8.38.2",
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },
@@ -179,4 +179,4 @@
       "strict": false
     }
   }
-}
+}

package/typings/promiseBasedTypes.d.ts

@@ -1147,13 +1147,15 @@ declare namespace CodeceptJS {
      * {
      *   helpers: {
      *     Playwright: {...},
-     *     Expect: {},
+     *     ExpectHelper: {},
      *   }
      * }
      * ```
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1200,6 +1202,164 @@ declare namespace CodeceptJS {
          * expects a JSON object matches a provided pattern
          */
         expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): Promise<any>;
+        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): Promise<any>;
+        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): Promise<any>;
+        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): Promise<any>;
+        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): Promise<any>;
+        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): Promise<any>;
+        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): Promise<any>;
+        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * @param [ajvOptions] - Pass AJV options
+         */
+        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): Promise<any>;
+        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
+        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
+        expectToBeA(targetData: any, type: any, customErrorMsg?: any): Promise<any>;
+        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): Promise<any>;
+        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): Promise<any>;
+        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): Promise<any>;
+        expectEmpty(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectTrue(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectFalse(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): Promise<any>;
+        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): Promise<any>;
+        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): Promise<any>;
+        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): Promise<any>;
+        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects members of two arrays are deeply equal
+         */
+        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects an array to be a superset of another array
+         */
+        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects members of two JSON objects are deeply equal excluding some properties
+         */
+        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects a JSON object matches a provided pattern
+         */
+        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): Promise<any>;
+    }
+    /**
+     * This helper allows performing assertions based on Chai.
+     *
+     * ### Examples
+     *
+     * Zero-configuration when paired with other helpers like REST, Playwright:
+     *
+     * ```js
+     * // inside codecept.conf.js
+     * {
+     *   helpers: {
+     *     Playwright: {...},
+     *     ExpectHelper: {},
+     *   }
+     * }
+     * ```
+     *
+     * ## Methods
+     */
+    // @ts-ignore
+    // @ts-ignore
+    class ExpectHelper {
+        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): Promise<any>;
+        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): Promise<any>;
+        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): Promise<any>;
+        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): Promise<any>;
+        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): Promise<any>;
+        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): Promise<any>;
+        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * @param [ajvOptions] - Pass AJV options
+         */
+        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): Promise<any>;
+        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
+        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
+        expectToBeA(targetData: any, type: any, customErrorMsg?: any): Promise<any>;
+        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): Promise<any>;
+        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): Promise<any>;
+        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): Promise<any>;
+        expectEmpty(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectTrue(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectFalse(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): Promise<any>;
+        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): Promise<any>;
+        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): Promise<any>;
+        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): Promise<any>;
+        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects members of two arrays are deeply equal
+         */
+        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects an array to be a superset of another array
+         */
+        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects members of two JSON objects are deeply equal excluding some properties
+         */
+        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects a JSON object matches a provided pattern
+         */
+        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): Promise<any>;
+        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): Promise<any>;
+        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): Promise<any>;
+        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): Promise<any>;
+        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): Promise<any>;
+        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): Promise<any>;
+        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): Promise<any>;
+        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * @param [ajvOptions] - Pass AJV options
+         */
+        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): Promise<any>;
+        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
+        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): Promise<any>;
+        expectToBeA(targetData: any, type: any, customErrorMsg?: any): Promise<any>;
+        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): Promise<any>;
+        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): Promise<any>;
+        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): Promise<any>;
+        expectEmpty(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectTrue(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectFalse(targetData: any, customErrorMsg?: any): Promise<any>;
+        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): Promise<any>;
+        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): Promise<any>;
+        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): Promise<any>;
+        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): Promise<any>;
+        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects members of two arrays are deeply equal
+         */
+        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects an array to be a superset of another array
+         */
+        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects members of two JSON objects are deeply equal excluding some properties
+         */
+        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): Promise<any>;
+        /**
+         * expects a JSON object matches a provided pattern
+         */
+        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): Promise<any>;
     }
     /**
      * Helper for testing filesystem.
@@ -1780,6 +1940,8 @@ 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
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1904,6 +2066,8 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server

package/typings/types.d.ts

@@ -1171,13 +1171,15 @@ declare namespace CodeceptJS {
      * {
      *   helpers: {
      *     Playwright: {...},
-     *     Expect: {},
+     *     ExpectHelper: {},
      *   }
      * }
      * ```
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1224,6 +1226,164 @@ declare namespace CodeceptJS {
          * expects a JSON object matches a provided pattern
          */
         expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): void;
+        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): void;
+        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): void;
+        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): void;
+        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): void;
+        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): void;
+        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): void;
+        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): void;
+        /**
+         * @param [ajvOptions] - Pass AJV options
+         */
+        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): void;
+        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
+        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
+        expectToBeA(targetData: any, type: any, customErrorMsg?: any): void;
+        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): void;
+        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): void;
+        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): void;
+        expectEmpty(targetData: any, customErrorMsg?: any): void;
+        expectTrue(targetData: any, customErrorMsg?: any): void;
+        expectFalse(targetData: any, customErrorMsg?: any): void;
+        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): void;
+        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): void;
+        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): void;
+        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): void;
+        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        /**
+         * expects members of two arrays are deeply equal
+         */
+        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        /**
+         * expects an array to be a superset of another array
+         */
+        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): void;
+        /**
+         * expects members of two JSON objects are deeply equal excluding some properties
+         */
+        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): void;
+        /**
+         * expects a JSON object matches a provided pattern
+         */
+        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): void;
+    }
+    /**
+     * This helper allows performing assertions based on Chai.
+     *
+     * ### Examples
+     *
+     * Zero-configuration when paired with other helpers like REST, Playwright:
+     *
+     * ```js
+     * // inside codecept.conf.js
+     * {
+     *   helpers: {
+     *     Playwright: {...},
+     *     ExpectHelper: {},
+     *   }
+     * }
+     * ```
+     *
+     * ## Methods
+     */
+    // @ts-ignore
+    // @ts-ignore
+    class ExpectHelper {
+        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): void;
+        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): void;
+        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): void;
+        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): void;
+        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): void;
+        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): void;
+        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): void;
+        /**
+         * @param [ajvOptions] - Pass AJV options
+         */
+        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): void;
+        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
+        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
+        expectToBeA(targetData: any, type: any, customErrorMsg?: any): void;
+        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): void;
+        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): void;
+        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): void;
+        expectEmpty(targetData: any, customErrorMsg?: any): void;
+        expectTrue(targetData: any, customErrorMsg?: any): void;
+        expectFalse(targetData: any, customErrorMsg?: any): void;
+        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): void;
+        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): void;
+        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): void;
+        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): void;
+        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        /**
+         * expects members of two arrays are deeply equal
+         */
+        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        /**
+         * expects an array to be a superset of another array
+         */
+        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): void;
+        /**
+         * expects members of two JSON objects are deeply equal excluding some properties
+         */
+        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): void;
+        /**
+         * expects a JSON object matches a provided pattern
+         */
+        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): void;
+        expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectNotDeepEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        expectContain(actualValue: any, expectedValueToContain: any, customErrorMsg?: any): void;
+        expectNotContain(actualValue: any, expectedValueToNotContain: any, customErrorMsg?: any): void;
+        expectStartsWith(actualValue: any, expectedValueToStartWith: any, customErrorMsg?: any): void;
+        expectNotStartsWith(actualValue: any, expectedValueToNotStartWith: any, customErrorMsg?: any): void;
+        expectEndsWith(actualValue: any, expectedValueToEndWith: any, customErrorMsg?: any): void;
+        expectNotEndsWith(actualValue: any, expectedValueToNotEndWith: any, customErrorMsg?: any): void;
+        expectJsonSchema(targetData: any, jsonSchema: any, customErrorMsg?: any): void;
+        /**
+         * @param [ajvOptions] - Pass AJV options
+         */
+        expectJsonSchemaUsingAJV(targetData: any, jsonSchema: any, customErrorMsg?: any, ajvOptions?: any): void;
+        expectHasProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
+        expectHasAProperty(targetData: any, propertyName: any, customErrorMsg?: any): void;
+        expectToBeA(targetData: any, type: any, customErrorMsg?: any): void;
+        expectToBeAn(targetData: any, type: any, customErrorMsg?: any): void;
+        expectMatchRegex(targetData: any, regex: any, customErrorMsg?: any): void;
+        expectLengthOf(targetData: any, length: any, customErrorMsg?: any): void;
+        expectEmpty(targetData: any, customErrorMsg?: any): void;
+        expectTrue(targetData: any, customErrorMsg?: any): void;
+        expectFalse(targetData: any, customErrorMsg?: any): void;
+        expectAbove(targetData: any, aboveThan: any, customErrorMsg?: any): void;
+        expectBelow(targetData: any, belowThan: any, customErrorMsg?: any): void;
+        expectLengthAboveThan(targetData: any, lengthAboveThan: any, customErrorMsg?: any): void;
+        expectLengthBelowThan(targetData: any, lengthBelowThan: any, customErrorMsg?: any): void;
+        expectEqualIgnoreCase(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        /**
+         * expects members of two arrays are deeply equal
+         */
+        expectDeepMembers(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
+        /**
+         * expects an array to be a superset of another array
+         */
+        expectDeepIncludeMembers(superset: any, set: any, customErrorMsg?: any): void;
+        /**
+         * expects members of two JSON objects are deeply equal excluding some properties
+         */
+        expectDeepEqualExcluding(actualValue: any, expectedValue: any, fieldsToExclude: any, customErrorMsg?: any): void;
+        /**
+         * expects a JSON object matches a provided pattern
+         */
+        expectMatchesPattern(actualValue: any, expectedPattern: any, customErrorMsg?: any): void;
     }
     /**
      * Helper for testing filesystem.
@@ -1807,6 +1967,8 @@ 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
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1931,6 +2093,8 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server