codeceptjs 3.4.1 → 3.5.1-2.beta.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.4.1",
+  "version": "3.5.12.beta.7",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -23,7 +23,6 @@
   },
   "files": [
     "bin",
-    "docs",
     "lib",
     "translations",
     "typings/**/*.d.ts"
@@ -40,109 +39,132 @@
     "lint": "eslint bin/ examples/ lib/ test/ translations/ runok.js",
     "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ runok.js --fix",
     "docs": "./runok.js docs",
-    "test:unit": "mocha test/unit --recursive",
-    "test:runner": "mocha test/runner --recursive --timeout 5000",
+    "test:unit": "mocha test/unit --recursive --timeout 10000",
+    "test:runner": "mocha test/runner --recursive --timeout 10000",
     "test": "npm run test:unit && npm run test:runner",
-    "test:appium-quick": "mocha test/helper/Appium_test.js --grep 'quick'",
-    "test:appium-other": "mocha test/helper/Appium_test.js --grep 'second'",
+    "test:appium-quick": "mocha test/helper/AppiumV2_test.js --grep 'quick'",
+    "test:appium-other": "mocha test/helper/AppiumV2_test.js --grep 'second'",
+    "test:ios:appium-quick": "mocha test/helper/AppiumV2_ios_test.js --grep 'quick'",
+    "test:ios:appium-other": "mocha test/helper/AppiumV2_ios_test.js --grep 'second'",
+    "test-app:start": "php -S 127.0.0.1:8000 -t test/data/app",
+    "test-app:stop": "kill -9 $(lsof -t -i:8000)",
+    "test:unit:webbapi:playwright": "mocha test/helper/Playwright_test.js",
+    "test:unit:webbapi:puppeteer": "mocha test/helper/Puppeteer_test.js",
+    "test:unit:webbapi:webDriver": "mocha test/helper/WebDriver_test.js",
+    "test:unit:webbapi:webDriver:noSeleniumServer": "mocha test/helper/WebDriver.noSeleniumServer_test.js",
+    "test:unit:webbapi:webDriver:devtools": "mocha test/helper/WebDriver_devtools_test.js --exit",
+    "test:unit:webbapi:testCafe": "mocha test/helper/TestCafe_test.js",
+    "test:unit:expect": "mocha test/helper/Expect_test.js",
+    "test:plugin": "mocha test/plugin/plugin_test.js",
     "def": "./runok.js def",
-    "dev:graphql": "nodemon test/data/graphql/index.js",
+    "dev:graphql": "node test/data/graphql/index.js",
     "publish:site": "./runok.js publish:site",
-    "update-contributor-faces": "contributor-faces .",
+    "update-contributor-faces": "./runok.js contributor:faces",
     "dtslint": "dtslint typings --localTs './node_modules/typescript/lib'",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "prepare-release": "./runok.js versioning && ./runok.js get:commit-log"
   },
   "dependencies": {
-    "@codeceptjs/configure": "^0.8.0",
-    "@codeceptjs/helper": "^1.0.2",
-    "@cucumber/cucumber-expressions": "^16",
-    "@cucumber/gherkin": "^26",
-    "@cucumber/messages": "^21.0.1",
-    "acorn": "^7.4.1",
-    "arrify": "^2.0.1",
-    "axios": "^1.3.3",
-    "chai": "^4.3.6",
-    "chai-deep-match": "^1.2.1",
-    "chalk": "^4.1.2",
-    "commander": "^2.20.3",
-    "cross-spawn": "^7.0.3",
-    "css-to-xpath": "^0.1.0",
-    "envinfo": "^7.8.1",
-    "escape-string-regexp": "^1.0.3",
-    "figures": "^3.2.0",
-    "fn-args": "^4.0.0",
-    "fs-extra": "^8.1.0",
-    "glob": "^6.0.1",
-    "inquirer": "^6.5.2",
-    "joi": "^17.6.0",
-    "js-beautify": "^1.14.0",
-    "lodash.clonedeep": "^4.5.0",
-    "lodash.merge": "^4.6.2",
-    "mkdirp": "^1.0.4",
-    "mocha": "^10.2.0",
-    "mocha-junit-reporter": "^1.23.3",
-    "ms": "^2.1.3",
-    "parse-function": "^5.6.4",
-    "promise-retry": "^1.1.1",
-    "resq": "^1.10.2",
-    "sprintf-js": "^1.1.1",
-    "uuid": "^9.0"
+    "@codeceptjs/configure": "0.10.0",
+    "@codeceptjs/helper": "2.0.1",
+    "@cucumber/cucumber-expressions": "17",
+    "@cucumber/gherkin": "26",
+    "@cucumber/messages": "24.0.1",
+    "@xmldom/xmldom": "0.8.10",
+    "acorn": "8.11.2",
+    "arrify": "2.0.1",
+    "axios": "1.6.3",
+    "chai": "4.3.8",
+    "chai-deep-match": "1.2.1",
+    "chai-exclude": "^2.1.0",
+    "chai-json-schema": "^1.5.1",
+    "chai-json-schema-ajv": "^5.2.4",
+    "chai-match-pattern": "^1.3.0",
+    "chai-string": "^1.5.0",
+    "chalk": "4.1.2",
+    "commander": "11.1.0",
+    "cross-spawn": "7.0.3",
+    "csstoxpath": "1.6.0",
+    "devtools": "8.27.2",
+    "envinfo": "7.11.0",
+    "escape-string-regexp": "4.0.0",
+    "figures": "3.2.0",
+    "fn-args": "4.0.0",
+    "fs-extra": "11.2.0",
+    "glob": "6.0.1",
+    "html-minifier-terser": "^7.2.0",
+    "inquirer": "6.5.2",
+    "joi": "17.11.0",
+    "js-beautify": "1.14.11",
+    "lodash.clonedeep": "4.5.0",
+    "lodash.merge": "4.6.2",
+    "mkdirp": "1.0.4",
+    "mocha": "10.2.0",
+    "ms": "2.1.3",
+    "openai": "3.2.1",
+    "ora-classic": "5.4.2",
+    "parse-function": "5.6.4",
+    "parse5": "7.1.2",
+    "promise-retry": "1.1.1",
+    "resq": "1.11.0",
+    "sprintf-js": "1.1.1",
+    "uuid": "9.0"
+  },
+  "optionalDependencies": {
+    "@codeceptjs/detox-helper": "1.0.2"
   },
   "devDependencies": {
-    "@codeceptjs/detox-helper": "^1.0.2",
-    "@codeceptjs/mock-request": "^0.3.1",
-    "@faker-js/faker": "^7.6.0",
-    "@pollyjs/adapter-puppeteer": "^5.1.0",
-    "@pollyjs/core": "^5.1.0",
-    "@types/inquirer": "^0.0.35",
-    "@types/node": "^8.10.66",
-    "@wdio/sauce-service": "^5.22.5",
-    "@wdio/selenium-standalone-service": "^5.16.10",
-    "@wdio/utils": "^5.23.0",
-    "apollo-server-express": "^2.25.3",
-    "chai-as-promised": "^7.1.1",
-    "chai-subset": "^1.6.0",
-    "contributor-faces": "^1.0.3",
-    "documentation": "^12.3.0",
-    "dtslint": "^4.1.6",
-    "electron": "^12.2.3",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-mocha": "^6.3.0",
-    "expect": "^26.6.2",
-    "express": "^4.17.2",
-    "form-data": "^3.0.1",
-    "graphql": "^14.6.0",
-    "husky": "^8.0.1",
-    "inquirer-test": "^2.0.1",
-    "jsdoc": "^3.6.10",
-    "jsdoc-typeof-plugin": "^1.0.0",
-    "json-server": "^0.10.1",
-    "nightmare": "^3.0.2",
-    "nodemon": "^1.19.4",
-    "playwright": "^1.23.2",
-    "puppeteer": "^10.4.0",
-    "qrcode-terminal": "^0.12.0",
-    "rosie": "^1.6.0",
-    "runok": "^0.9.2",
-    "sinon": "^9.2.4",
-    "sinon-chai": "^3.7.0",
-    "testcafe": "^2.1.0",
-    "ts-morph": "^3.1.3",
-    "ts-node": "^10.9.1",
-    "tsd-jsdoc": "^2.5.0",
-    "typedoc": "^0.23.10",
-    "typedoc-plugin-markdown": "^3.13.4",
-    "typescript": "^4.8.4",
-    "wdio-docker-service": "^1.5.0",
-    "webdriverio": "^8.3.8",
-    "xml2js": "^0.4.23",
-    "xmldom": "^0.1.31",
-    "xpath": "0.0.27"
+    "@codeceptjs/mock-request": "0.3.1",
+    "@faker-js/faker": "7.6.0",
+    "@pollyjs/adapter-puppeteer": "6.0.6",
+    "@pollyjs/core": "5.1.0",
+    "@types/chai": "^4.3.7",
+    "@types/inquirer": "9.0.3",
+    "@types/node": "20.10.7",
+    "@wdio/sauce-service": "8.27.0",
+    "@wdio/selenium-standalone-service": "8.3.2",
+    "@wdio/utils": "8.27.2",
+    "@xmldom/xmldom": "0.8.10",
+    "apollo-server-express": "2.25.3",
+    "chai-as-promised": "7.1.1",
+    "chai-subset": "1.6.0",
+    "contributor-faces": "1.1.0",
+    "documentation": "12.3.0",
+    "dtslint": "4.2.1",
+    "electron": "28.0.0",
+    "eslint": "8.56.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-mocha": "6.3.0",
+    "expect": "29.7.0",
+    "express": "4.18.2",
+    "graphql": "14.6.0",
+    "husky": "8.0.3",
+    "inquirer-test": "2.0.1",
+    "jsdoc": "3.6.11",
+    "jsdoc-typeof-plugin": "1.0.0",
+    "json-server": "0.10.1",
+    "playwright": "1.40.1",
+    "puppeteer": "21.1.1",
+    "qrcode-terminal": "0.12.0",
+    "rosie": "2.1.1",
+    "runok": "0.9.3",
+    "sinon": "17.0.1",
+    "sinon-chai": "3.7.0",
+    "testcafe": "3.3.0",
+    "ts-morph": "21.0.1",
+    "ts-node": "10.9.2",
+    "tsd-jsdoc": "2.5.0",
+    "typedoc": "0.25.7",
+    "typedoc-plugin-markdown": "3.17.1",
+    "typescript": "5.3.3",
+    "wdio-docker-service": "1.5.0",
+    "webdriverio": "8.27.2",
+    "xml2js": "0.6.2",
+    "xpath": "0.0.34"
   },
   "engines": {
-    "node": ">=8.9.1",
+    "node": ">=16.0",
     "npm": ">=5.6.0"
   },
   "es6": true

package/translations/de-DE.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: 'Ich',
+  contexts: {
+    Feature: 'Funktionalität',
+    Scenario: 'Szenario',
+    ScenarioOutline: 'Szenariogrundriss',
+  },
   actions: {
     amOutsideAngularApp: 'befinde_mich_außerhalb_der_angular_app',
     amInsideAngularApp: 'bedinde_mich_innerhalb_der_angular_app',

package/translations/fr-FR.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Fonctionnalité',
     Scenario: 'Scénario',
+    ScenarioOutline: 'Plan du scénario',
     Before: 'Avant',
     After: 'Après',
     BeforeSuite: 'AvantLaSuite',
@@ -12,11 +13,15 @@ module.exports = {
     amOutsideAngularApp: 'suisALExtérieurDeLApplicationAngular',
     amInsideAngularApp: 'suisALIntérieurDeLApplicationAngular',
     waitForElement: 'attendsLElément',
-    waitForClickable: 'attends',
+    waitForClickable: 'attendsDeCliquer',
     waitForVisible: 'attendsPourVoir',
+    waitForEnabled: 'attendsLActivationDe',
+    waitForInvisible: 'attendsLInvisibilitéDe',
+    waitInUrl: 'attendsDansLUrl',
     waitForText: 'attendsLeTexte',
     moveTo: 'vaisSur',
     refresh: 'rafraîchis',
+    refreshPage: 'rafraîchisLaPage',
     haveModule: 'ajouteLeModule',
     resetModule: 'réinitialiseLeModule',
     amOnPage: 'suisSurLaPage',
@@ -59,5 +64,13 @@ module.exports = {
     grabCookie: 'prendsLeCookie',
     resizeWindow: 'redimensionneLaFenêtre',
     wait: 'attends',
+    clearField: 'effaceLeChamp',
+    dontSeeElementInDOM: 'neVoisPasDansLeDOM',
+    moveCursorTo: 'bougeLeCurseurSur',
+    scrollTo: 'défileVers',
+    sendGetRequest: 'envoieLaRequêteGet',
+    sendPutRequest: 'envoieLaRequêtePut',
+    sendDeleteRequest: 'envoieLaRequêteDelete',
+    sendPostRequest: 'envoieLaRequêtePost',
   },
 };

package/translations/it-IT.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Caratteristica',
     Scenario: 'lo_scenario',
+    ScenarioOutline: 'Schema dello scenario',
     Before: 'Prima',
     After: 'Dopo',
     BeforeSuite: 'Prima_della_suite',

package/translations/ja-JP.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: '私は',
+  contexts: {
+    Feature: 'フィーチャ',
+    Scenario: 'シナリオ',
+    ScenarioOutline: 'シナリオアウトライン',
+  },
   actions: {
     amOutsideAngularApp: 'Angularの外に出る',
     amInsideAngularApp: 'Angularの中に入る',
@@ -14,34 +19,34 @@ module.exports = {
     amOnPage: 'ページを移動する',
     click: 'クリックする',
     doubleClick: 'ダブルクリックする',
-    see: 'テキストがあるか確認する',
+    see: 'テキストがあることを確認する',
     dontSee: 'テキストがないことを確認する',
     selectOption: 'オプションを選ぶ',
     fillField: 'フィールドに入力する',
     pressKey: 'キー入力する',
     triggerMouseEvent: 'マウスイベントを発火させる',
     attachFile: 'ファイルを添付する',
-    seeInField: 'フィールドに文字が入っているか確認する',
-    dontSeeInField: 'フィールドに文字が入っていないか確認する',
+    seeInField: 'フィールドに文字が入っていることを確認する',
+    dontSeeInField: 'フィールドに文字が入っていないことを確認する',
     appendField: 'フィールドに文字を追加する',
     checkOption: 'オプションをチェックする',
-    seeCheckboxIsChecked: 'チェックされているか確認する',
+    seeCheckboxIsChecked: 'チェックされていることを確認する',
     dontSeeCheckboxIsChecked: 'チェックされていないことを確認する',
     grabTextFrom: 'テキストを取得する',
     grabValueFrom: '入力値を取得する',
     grabAttributeFrom: '要素を取得する',
-    seeInTitle: 'タイトルに文字が含まれるか確認する',
+    seeInTitle: 'タイトルに文字が含まれていることを確認する',
     dontSeeInTitle: 'タイトルに文字が含まれないことを確認する',
     grabTitle: 'タイトルを取得する',
-    seeElement: '要素があるか確認する',
+    seeElement: '要素があることを確認する',
     dontSeeElement: '要素がないことを確認する',
-    seeInSource: 'ソースにあるか確認する',
+    seeInSource: 'ソースにあることを確認する',
     dontSeeInSource: 'ソースにないことを確認する',
     executeScript: 'スクリプトを実行する',
     executeAsyncScript: '非同期スクリプトを実行する',
-    seeInCurrentUrl: 'URLに含まれるか確認する',
+    seeInCurrentUrl: 'URLに含まれることを確認する',
     dontSeeInCurrentUrl: 'URLに含まれないことを確認する',
-    seeCurrentUrlEquals: 'URLが等しいか確認する',
+    seeCurrentUrlEquals: 'URLが等しいことを確認する',
     dontSeeCurrentUrlEquals: 'URLが等しくないことを確認する',
     saveScreenshot: 'スクリーンショットを保存する',
     setCookie: 'Cookieをセットする',

package/translations/pl-PL.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: 'Ja',
+  contexts: {
+    Feature: 'Funkcja',
+    Scenario: 'Scenariusz',
+    ScenarioOutline: 'Szablon scenariusza',
+  },
   actions: {
     amOutsideAngularApp: 'jestem_poza_aplikacją_angular',
     amInsideAngularApp: 'jestem_w_aplikacji_angular',

package/translations/pt-BR.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Funcionalidade',
     Scenario: 'Cenário',
+    ScenarioOutline: 'Esquema do Cenário',
     Before: 'Antes',
     After: 'Depois',
     BeforeSuite: 'AntesDaSuite',

package/translations/ru-RU.js

@@ -3,6 +3,7 @@ module.exports = {
   contexts: {
     Feature: 'Цель',
     Scenario: 'Сценарий',
+    ScenarioOutline: 'Структура сценария',
     Before: 'Начало',
     After: 'Конец',
     BeforeSuite: 'Перед_всем',

package/translations/zh-CN.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: '我',
+  contexts: {
+    Feature: '功能',
+    Scenario: '场景',
+    ScenarioOutline: '场景大纲',
+  },
   actions: {
     amOutsideAngularApp: '在Angular应用外',
     amInsideAngularApp: '在Angular应用内',

package/translations/zh-TW.js

@@ -1,5 +1,10 @@
 module.exports = {
   I: '我',
+  contexts: {
+    Feature: '功能',
+    Scenario: '場景',
+    ScenarioOutline: '場景大綱',
+  },
   actions: {
     amOutsideAngularApp: '在Angular應用外',
     amInsideAngularApp: '在Angular應用內',

package/typings/index.d.ts

@@ -12,26 +12,26 @@ declare namespace CodeceptJS {
 
   type Cookie = {
     name: string;
-    value: string;
+    value: string | boolean;
     domain?: string,
     path?: string,
   };
 
   type RetryConfig = {
     /** Filter tests by string or regexp pattern */
-    grep: string | RegExp;
+    grep?: string | RegExp;
     /** Number of times to repeat scenarios of a Feature */
-    Feature: number;
+    Feature?: number;
     /** Number of times to repeat scenarios */
-    Scenario: number;
+    Scenario?: number;
     /** Number of times to repeat Before hook */
-    Before: number;
+    Before?: number;
     /** Number of times to repeat After hook */
-    After: number;
+    After?: number;
     /** Number of times to repeat BeforeSuite hook */
-    BeforeSuite: number;
+    BeforeSuite?: number;
     /** Number of times to repeat AfterSuite hook */
-    AfterSuite: number;
+    AfterSuite?: number;
   };
 
   type TimeoutConfig = {
@@ -67,6 +67,14 @@ declare namespace CodeceptJS {
      * ```
      */
     output: string;
+    /**
+     * empty output folder for next run
+     *
+     * ```js
+     * emptyOutputFolder: true
+     * ```
+     */
+    emptyOutputFolder?: boolean;
     /**
      * Pattern to filter tests by name.
      * This option is useful if you plan to use multiple configs for different environments.
@@ -89,7 +97,7 @@ declare namespace CodeceptJS {
      *   }
      * }
      * ```
-    */
+     */
     helpers?: {
       /**
        * Run web tests controlling browsers via Playwright engine.
@@ -281,7 +289,7 @@ declare namespace CodeceptJS {
      * ```js
      * bootstrap: 'bootstrap.js',
      * ```
-    */
+     */
     bootstrap?: (() => Promise<void>) | boolean | string;
     /**
      * [Execute code after tests](https://codecept.io/bootstrap/) finished.
@@ -295,7 +303,7 @@ declare namespace CodeceptJS {
      * ```js
      * teardown: 'teardown.js',
      * ```
-    */
+     */
     teardown?: (() => Promise<void>) | boolean | string;
     /**
      * [Execute code before launching tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)
@@ -304,7 +312,7 @@ declare namespace CodeceptJS {
     bootstrapAll?: (() => Promise<void>) | boolean | string;
     /**
      * [Execute JS code after finishing tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)
-    */
+     */
     teardownAll?: (() => Promise<void>) | boolean | string;
 
     /** Enable [localized test commands](https://codecept.io/translation/) */
@@ -320,7 +328,7 @@ declare namespace CodeceptJS {
      * ```
      * require: ["should"]
      * ```
-    */
+     */
     require?: Array<string>;
 
     /**
@@ -341,6 +349,29 @@ declare namespace CodeceptJS {
       steps: string | Array<string>
     };
 
+    /**
+     * [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>,
+      }
+    },
+
     /**
      * Enable full promise-based helper methods for [TypeScript](https://codecept.io/typescript/) project.
      * If true, all helper methods are typed as asynchronous;
@@ -392,14 +423,17 @@ declare namespace CodeceptJS {
     | { ios: string }
     | { android: string; ios: string }
     | { react: string }
-    | { shadow: string }
+    | { vue: string }
+    | { shadow: string[] }
     | { custom: string };
 
   interface CustomLocators {}
+  interface OtherLocators { props?: object }
   type LocatorOrString =
     | string
     | ILocator
     | Locator
+    | OtherLocators
     | CustomLocators[keyof CustomLocators];
 
   type StringOrSecret = string | CodeceptJS.Secret;
@@ -489,8 +523,10 @@ declare const Background: CodeceptJS.IHook;
 declare const Before: CodeceptJS.IHook;
 declare const After: CodeceptJS.IHook;
 
+// Plugins
+declare const __: any
+
 interface Window {
-  codeceptjs: typeof CodeceptJS.browserCodecept;
   resq: any;
 }