codeceptjs 3.6.0 → 3.6.1

package/lib/pause.js

@@ -6,7 +6,7 @@ const debug = require('debug')('codeceptjs:pause');
 const container = require('./container');
 const history = require('./history');
 const store = require('./store');
-const AiAssistant = require('./ai');
+const aiAssistant = require('./ai');
 const recorder = require('./recorder');
 const event = require('./event');
 const output = require('./output');
@@ -18,7 +18,6 @@ let nextStep;
 let finish;
 let next;
 let registeredVariables = {};
-let aiAssistant;
 /**
  * Pauses test execution and starts interactive shell
  * @param {Object<string, *>} [passedObject]
@@ -44,8 +43,6 @@ function pauseSession(passedObject = {}) {
     let vars = Object.keys(registeredVariables).join(', ');
     if (vars) vars = `(vars: ${vars})`;
 
-    aiAssistant = AiAssistant.getInstance();
-
     output.print(colors.yellow(' Interactive shell started'));
     output.print(colors.yellow(' Use JavaScript syntax to try steps in action'));
     output.print(colors.yellow(` - Press ${colors.bold('ENTER')} to run the next step`));
@@ -54,11 +51,9 @@ function pauseSession(passedObject = {}) {
     output.print(colors.yellow(` - Prefix ${colors.bold('=>')} to run js commands ${colors.bold(vars)}`));
 
     if (aiAssistant.isEnabled) {
-      output.print(colors.blue(` ${colors.bold('OpenAI is enabled! (experimental)')} Write what you want and make OpenAI run it`));
-      output.print(colors.blue(' Please note, only HTML fragments with interactive elements are sent to OpenAI'));
+      output.print(colors.blue(` ${colors.bold('AI is enabled! (experimental)')} Write what you want and make AI run it`));
+      output.print(colors.blue(' Please note, only HTML fragments with interactive elements are sent to AI provider'));
       output.print(colors.blue(' Ideas: ask it to fill forms for you or to click'));
-    } else {
-      output.print(colors.blue(` Enable OpenAI assistant by setting ${colors.bold('OPENAI_API_KEY')} env variable`));
     }
   }
   rl = readline.createInterface(process.stdin, process.stdout, completer);
@@ -125,7 +120,7 @@ async function parseInput(cmd) {
         } finally {
           output.level(currentOutputLevel);
         }
-        // aiAssistant.mockResponse("```js\nI.click('Sign in');\n```");
+
         const spinner = ora("Processing OpenAI request...").start();
         cmd = await aiAssistant.writeSteps(cmd);
         spinner.stop();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.0",
+  "version": "3.6.1",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -69,7 +69,7 @@
   },
   "dependencies": {
     "@codeceptjs/configure": "1.0.1",
-    "@codeceptjs/helper": "2.0.1",
+    "@codeceptjs/helper": "2.0.4",
     "@cucumber/cucumber-expressions": "17",
     "@cucumber/gherkin": "26",
     "@cucumber/messages": "24.1.0",

package/typings/types.d.ts

@@ -12377,14 +12377,14 @@ declare namespace CodeceptJS {
      * Detox provides a grey box testing for mobile applications, playing especially good for React Native apps.
      *
      * Detox plays quite differently from Appium. To establish detox testing you need to build a mobile application in a special way to inject Detox code.
-     * This why **Detox is grey box testing** solution, so you need access to application source code, and a way to build and execute it on emulator.
+     * This why **Detox is grey box testing** solution, so you need an access to application source code, and a way to build and execute it on emulator.
      *
      * Comparing to Appium, Detox runs faster and more stable but requires an additional setup for build.
      *
      * ### Setup
      *
-     * 1. [Install and configure Detox](https://wix.github.io/Detox/docs/introduction/project-setup)
-     * 2. [Build an application](https://wix.github.io/Detox/docs/introduction/project-setup#step-5-build-the-app) using `detox build` command.
+     * 1. [Install and configure Detox for iOS](https://github.com/wix/Detox/blob/master/docs/Introduction.GettingStarted.md) and [Android](https://github.com/wix/Detox/blob/master/docs/Introduction.Android.md)
+     * 2. [Build an application](https://github.com/wix/Detox/blob/master/docs/Introduction.GettingStarted.md#step-4-build-your-app-and-run-detox-tests) using `detox build` command.
      * 3. Install [CodeceptJS](https://codecept.io) and detox-helper:
      *
      * ```
@@ -12397,28 +12397,15 @@ declare namespace CodeceptJS {
      *
      * ```js
      *  "detox": {
-     *     "configurations": {
-     *       "ios.sim.debug": {
-     *         "device": "simulator",
-     *         "app": "ios.debug"
-     *       }
-     *     },
-     *     "apps": {
-     *       "ios.debug": {
-     *         "type": "ios.app",
-     *         "binaryPath": "../test/ios/build/Build/Products/Debug-iphonesimulator/MyTestApp.app",
-     *         "build": "xcodebuild -workspace ../test/ios/MyTestApp.xcworkspace -scheme MyTestApp -configuration Debug -sdk iphonesimulator -derivedDataPath ../test/ios/build"
-     *       }
-     *     },
-     *     "devices": {
-     *       "simulator": {
-     *         "type": "ios.simulator",
-     *         "device": {
-     *           "type": "iPhone 15"
-     *         }
-     *       }
-     *     }
-     *   }
+     *    "configurations": {
+     *      "ios.sim.debug": {
+     *        "binaryPath": "ios/build/Build/Products/Debug-iphonesimulator/example.app",
+     *        "build": "xcodebuild -project ios/example.xcodeproj -scheme example -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build",
+     *        "type": "ios.simulator",
+     *        "name": "iPhone 7"
+     *      }
+     *    }
+     *  }
      * ```
      *
      *
@@ -12513,14 +12500,6 @@ declare namespace CodeceptJS {
          * ```
          */
         setPortraitOrientation(): void;
-        /**
-         * Grab the device platform
-         *
-         * ```js
-         * const platform = await I.grabPlatform();
-         * ```
-         */
-        grabPlatform(): void;
         /**
          * Execute code only on iOS
          *
@@ -12610,19 +12589,6 @@ declare namespace CodeceptJS {
          * ```
          */
         click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
-        /**
-         * Clicks on an element.
-         * Element can be located by its label
-         *
-         * The second parameter is a context (id | type | accessibility id) to narrow the search.
-         *
-         *
-         * ```js
-         * I.tapByLabel('Login'); // locate by text
-         * I.tapByLabel('Login', '#nav'); // locate by text inside #nav
-         * ```
-         */
-        tapByLabel(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
         /**
          * Performs click on element with horizontal and vertical offset.
          * An element is located by text, id, accessibility id.
@@ -12673,17 +12639,6 @@ declare namespace CodeceptJS {
          * @param [context = null] - context element
          */
         seeElement(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
-        /**
-         * Checks if an element exists.
-         *
-         * ```js
-         * I.checkIfElementExists('~edit'); // located by accessibility id
-         * I.checkIfElementExists('~edit', '#menu'); // element inside #menu
-         * ```
-         * @param locator - element to locate
-         * @param [context = null] - context element
-         */
-        checkIfElementExists(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
         /**
          * Checks that element is not visible.
          * Use second parameter to narrow down the search.
@@ -12733,18 +12688,6 @@ declare namespace CodeceptJS {
          * @param value - value to fill
          */
         fillField(field: CodeceptJS.LocatorOrString, value: string): void;
-        /**
-         * Taps return key.
-         * A field can be located by text, accessibility id, id.
-         *
-         * ```js
-         * I.tapReturnKey('Username');
-         * I.tapReturnKey('~name');
-         * I.tapReturnKey({ android: 'NAME', ios: 'name' });
-         * ```
-         * @param field - an input element to fill in
-         */
-        tapReturnKey(field: CodeceptJS.LocatorOrString): void;
         /**
          * Clears a text field.
          * A field can be located by text, accessibility id, id.
@@ -12870,7 +12813,7 @@ declare namespace CodeceptJS {
          */
         waitForElementVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
         /**
-         * Waits an elmenet to become not visible.
+         * Waits an elment to become not visible.
          *
          * ```js
          * I.waitToHide('#message', 2); // wait for 2 seconds
@@ -12879,14 +12822,6 @@ declare namespace CodeceptJS {
          * @param [sec = 5] - number of seconds to wait
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
-        /**
-         * Scrolls within a scrollable container to an element.
-         * @param targetLocator - Locator of the element to scroll to
-         * @param containerLocator - Locator of the scrollable container
-         * @param direction - 'up' or 'down'
-         * @param [offset = 100] - Offset for scroll, can be adjusted based on need
-         */
-        scrollToElement(targetLocator: CodeceptJS.LocatorOrString, containerLocator: CodeceptJS.LocatorOrString, direction?: string, offset?: number): void;
     }
     /**
      * Abstract class.