codeceptjs 4.0.2-beta.9 → 4.0.2

package/docs/webapi/startRecordingTraffic.mustache

@@ -1,8 +0,0 @@
-Starts recording the network traffics.
-This also resets recorded network requests.
-
-```js
-I.startRecordingTraffic();
-```
-
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/startRecordingWebSocketMessages.mustache

@@ -1,8 +0,0 @@
-Starts recording of websocket messages.
-This also resets recorded websocket messages.
-
-```js
-await I.startRecordingWebSocketMessages();
-```
-
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/stopRecordingTraffic.mustache

@@ -1,5 +0,0 @@
-Stops recording of network traffic. Recorded traffic is not flashed.
-
-```js
-I.stopRecordingTraffic();
-```

package/docs/webapi/stopRecordingWebSocketMessages.mustache

@@ -1,7 +0,0 @@
-Stops recording WS messages. Recorded WS messages is not flashed.
-
-```js
-await I.stopRecordingWebSocketMessages();
-```
-
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/switchTo.mustache

@@ -1,9 +0,0 @@
-Switches frame or in case of null locator reverts to parent.
-
-```js
-I.switchTo('iframe'); // switch to first iframe
-I.switchTo(); // switch back to main page
-```
-
-@param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/switchToNextTab.mustache

@@ -1,10 +0,0 @@
-Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
-
-```js
-I.switchToNextTab();
-I.switchToNextTab(2);
-```
-
-@param {number} [num] (optional) number of tabs to switch forward, default: 1.
-@param {number | null} [sec] (optional) time in seconds to wait.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/switchToPreviousTab.mustache

@@ -1,10 +0,0 @@
-Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
-
-```js
-I.switchToPreviousTab();
-I.switchToPreviousTab(2);
-```
-
-@param {number} [num] (optional) number of tabs to switch backward, default: 1.
-@param {number?} [sec] (optional) time in seconds to wait.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/type.mustache

@@ -1,21 +0,0 @@
-Types out the given text into an active field.
-To slow down typing use a second parameter, to set interval between key presses.
-_Note:_ Should be used when [`fillField`](#fillfield) is not an option.
-
-```js
-// passing in a string
-I.type('Type this out.');
-
-// typing values with a 100ms interval
-I.type('4141555311111111', 100);
-
-// passing in an array
-I.type(['T', 'E', 'X', 'T']);
-
-// passing a secret
-I.type(secret('123456'));
-```
-
-@param {string|string[]} key or array of keys to type.
-@param {?number} [delay=null] (optional) delay in ms between key presses
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/uncheckOption.mustache

@@ -1,13 +0,0 @@
-Unselects a checkbox or radio button.
-Element is located by label or name or CSS or XPath.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-I.uncheckOption('#agree');
-I.uncheckOption('I Agree to Terms and Conditions');
-I.uncheckOption('agree', '//form');
-```
-@param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/wait.mustache

@@ -1,8 +0,0 @@
-Pauses execution for a number of seconds.
-
-```js
-I.wait(2); // wait 2 secs
-```
-
-@param {number} sec number of second to wait.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForClickable.mustache

@@ -1,11 +0,0 @@
-Waits for element to be clickable (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForClickable('.btn.continue');
-I.waitForClickable('.btn.continue', 5); // wait for 5 secs
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForCookie.mustache

@@ -1,9 +0,0 @@
-Waits for the specified cookie in the cookies.
-
-```js
-I.waitForCookie("token");
-```
-
-@param {string} name expected cookie name.
-@param {number} [sec=3] (optional, `3` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForDetached.mustache

@@ -1,10 +0,0 @@
-Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForDetached('#popup');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForDisabled.mustache

@@ -1,6 +0,0 @@
-Waits for element to become disabled (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForElement.mustache

@@ -1,11 +0,0 @@
-Waits for element to be present on page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForElement('.btn.continue');
-I.waitForElement('.btn.continue', 5); // wait for 5 secs
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForEnabled.mustache

@@ -1,6 +0,0 @@
-Waits for element to become enabled (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForFunction.mustache

@@ -1,17 +0,0 @@
-Waits for a function to return true (waits for 1 sec by default).
-Running in browser context.
-
-```js
-I.waitForFunction(fn[, [args[, timeout]])
-```
-
-```js
-I.waitForFunction(() => window.requests == 0);
-I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
-I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
-```
-
-@param {string|function} fn to be executed in browser context.
-@param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
-@param {number} [sec] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForInvisible.mustache

@@ -1,10 +0,0 @@
-Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForInvisible('#popup');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForNumberOfTabs.mustache

@@ -1,9 +0,0 @@
-Waits for number of tabs.
-
-```js
-I.waitForNumberOfTabs(2);
-```
-
-@param {number} expectedTabs expecting the number of tabs.
-@param {number} sec number of secs to wait.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForText.mustache

@@ -1,13 +0,0 @@
-Waits for a text to appear (by default waits for 1sec).
-Element can be located by CSS or XPath.
-Narrow down search results by providing context.
-
-```js
-I.waitForText('Thank you, form has been submitted');
-I.waitForText('Thank you, form has been submitted', 5, '#modal');
-```
-
-@param {string }text to wait for.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForValue.mustache

@@ -1,10 +0,0 @@
-Waits for the specified value to be in value attribute.
-
-```js
-I.waitForValue('//input', "GoodValue");
-```
-
-@param {LocatorOrString} field input field.
-@param {string }value expected value.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForVisible.mustache

@@ -1,10 +0,0 @@
-Waits for an element to become visible on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForVisible('#popup');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitInUrl.mustache

@@ -1,9 +0,0 @@
-Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
-
-```js
-I.waitInUrl('/info', 2);
-```
-
-@param {string} urlPart value to check.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitNumberOfVisibleElements.mustache

@@ -1,10 +0,0 @@
-Waits for a specified number of elements on the page.
-
-```js
-I.waitNumberOfVisibleElements('a', 3);
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} num number of elements.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitToHide.mustache

@@ -1,10 +0,0 @@
-Waits for an element to hide (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitToHide('#popup');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitUrlEquals.mustache

@@ -1,10 +0,0 @@
-Waits for the entire URL to match the expected
-
-```js
-I.waitUrlEquals('/info', 2);
-I.waitUrlEquals('http://127.0.0.1:8000/info');
-```
-
-@param {string} urlPart value to check.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/lib/helper/AI.js

@@ -1,214 +0,0 @@
-import HelperModule from '@codeceptjs/helper'
-import ora from 'ora-classic'
-import fs from 'fs'
-import path from 'path'
-import ai from '../ai.js'
-import Container from '../container.js'
-import { splitByChunks, minifyHtml } from '../html.js'
-import { beautify } from '../utils.js'
-import output from '../output.js'
-import { registerVariable } from '../pause.js'
-
-const standardActingHelpers = Container.STANDARD_ACTING_HELPERS
-
-const gtpRole = {
-  user: 'user',
-}
-
-/**
- * AI Helper for 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 WebDriver 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.conf.{js|ts}
- *
- * * `chunkSize`: (optional, default: 80000) - The maximum number of characters to send to the AI API at once. We split HTML fragments by 8000 chars to not exceed token limit. Increase this value if you use GPT-4.
- */
-class AI extends Helper {
-  constructor(config) {
-    super(config)
-    this.aiAssistant = ai
-
-    this.options = {
-      chunkSize: 80000,
-    }
-    this.options = { ...this.options, ...config }
-    this.aiAssistant.enable(this.config)
-  }
-
-  _beforeSuite() {
-    const helpers = Container.helpers()
-
-    for (const helperName of standardActingHelpers) {
-      if (Object.keys(helpers).indexOf(helperName) > -1) {
-        this.helper = helpers[helperName]
-        break
-      }
-    }
-  }
-
-  /**
-   * Asks the AI GPT language model a question based on the provided prompt within the context of the current page's HTML.
-   *
-   * ```js
-   * I.askGptOnPage('what does this page do?');
-   * ```
-   *
-   * @async
-   * @param {string} prompt - The question or prompt to ask the GPT model.
-   * @returns {Promise<string>} - A Promise that resolves to the generated responses from the GPT model, joined by newlines.
-   */
-  async askGptOnPage(prompt) {
-    const html = await this.helper.grabSource()
-
-    const htmlChunks = splitByChunks(html, this.options.chunkSize)
-
-    if (htmlChunks.length > 1) this.debug(`Splitting HTML into ${htmlChunks.length} chunks`)
-
-    const responses = []
-
-    for (const chunk of htmlChunks) {
-      const messages = [
-        { role: gtpRole.user, content: prompt },
-        { role: gtpRole.user, content: `Within this HTML: ${await minifyHtml(chunk)}` },
-      ]
-
-      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._processAIRequest(messages)
-
-      output.print(response)
-
-      responses.push(response)
-    }
-
-    return responses.join('\n\n')
-  }
-
-  /**
-   * Asks the AI a question based on the provided prompt within the context of a specific HTML fragment on the current page.
-   *
-   * ```js
-   * I.askGptOnPageFragment('describe features of this screen', '.screen');
-   * ```
-   *
-   * @async
-   * @param {string} prompt - The question or prompt to ask the GPT-3.5 model.
-   * @param {string} locator - The locator or selector used to identify the HTML fragment on the page.
-   * @returns {Promise<string>} - A Promise that resolves to the generated response from the GPT model.
-   */
-  async askGptOnPageFragment(prompt, locator) {
-    const html = await this.helper.grabHTMLFrom(locator)
-
-    const messages = [
-      { role: gtpRole.user, content: prompt },
-      { role: gtpRole.user, content: `Within this HTML: ${await minifyHtml(html)}` },
-    ]
-
-    const response = await this._processAIRequest(messages)
-
-    output.print(response)
-
-    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.
-   */
-  async askGptGeneralPrompt(prompt) {
-    const messages = [{ role: gtpRole.user, content: prompt }]
-
-    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 spinner = ora(' Processing AI request...').start()
-
-    try {
-      const html = locator ? await this.helper.grabHTMLFrom(locator) : await this.helper.grabSource()
-      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])
-
-      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
-    } catch (e) {
-      spinner.stop()
-      throw Error(`Something went wrong! ${e.message}`)
-    }
-  }
-
-  async _processAIRequest(messages) {
-    const spinner = ora(' Processing AI request...').start()
-    const response = await this.aiAssistant.createCompletion(messages)
-    spinner.stop()
-    return response
-  }
-}
-
-export default AI

package/lib/helper/Mochawesome.js

@@ -1,96 +0,0 @@
-let currentTest
-let currentSuite
-
-import Helper from '@codeceptjs/helper'
-import { createRequire } from 'module'
-import { clearString } from '../utils.js'
-import { testToFileName } from '../mocha/test.js'
-
-class Mochawesome extends Helper {
-  constructor(config) {
-    super(config)
-
-    // set defaults
-    this.options = {
-      uniqueScreenshotNames: false,
-      disableScreenshots: false,
-    }
-
-    // ESM-compatible require for CommonJS module
-    const require = createRequire(import.meta.url)
-    this._addContext = require('mochawesome/addContext')
-
-    this._createConfig(config)
-  }
-
-  _createConfig(config) {
-    // override defaults with config
-    Object.assign(this.options, config)
-  }
-
-  _beforeSuite(suite) {
-    currentSuite = suite
-    currentTest = ''
-  }
-
-  _before() {
-    if (currentSuite && currentSuite.ctx) {
-      currentTest = { test: currentSuite.ctx.currentTest }
-    }
-  }
-
-  _test(test) {
-    // If this is a retried test, we want to add context to the retried test
-    // but also potentially preserve context from the original test
-    const originalTest = test.retriedTest && test.retriedTest()
-    if (originalTest) {
-      // This is a retried test - use the retried test for context
-      currentTest = { test }
-
-      // Optionally copy context from original test if it exists
-      // Note: mochawesome context is stored in test.ctx, but we need to be careful
-      // not to break the mocha context structure
-    } else {
-      // Normal test (not a retry)
-      currentTest = { test }
-    }
-  }
-
-  _failed(test) {
-    if (this.options.disableScreenshots) return
-    let fileName
-    // Get proper name if we are fail on hook
-    if (test.ctx?.test?.type === 'hook') {
-      currentTest = { test: test.ctx.test }
-      // ignore retries if we are in hook
-      test._retries = -1
-      fileName = clearString(`${test.title}_${currentTest.test.title}`)
-    } else {
-      currentTest = { test }
-      fileName = testToFileName(test)
-    }
-    if (this.options.uniqueScreenshotNames) {
-      fileName = testToFileName(test, { unique: true })
-    }
-    if (test._retries < 1 || test._retries === test.retryNum) {
-      fileName = `${fileName}.failed.png`
-      return this._addContext(currentTest, fileName)
-    }
-  }
-
-  addMochawesomeContext(context) {
-    if (currentTest === '') currentTest = { test: currentSuite.ctx.test }
-
-    // For retried tests, make sure we're adding context to the current (retried) test
-    // not the original test
-    let targetTest = currentTest
-    if (currentTest.test && currentTest.test.retriedTest && currentTest.test.retriedTest()) {
-      // This test has been retried, make sure we're using the current test for context
-      targetTest = { test: currentTest.test }
-    }
-
-    return this._addContext(targetTest, context)
-  }
-}
-
-export default Mochawesome

package/lib/helper/extras/PlaywrightReactVueLocator.js

@@ -1,52 +0,0 @@
-async function findReact(matcher, locator) {
-  // Handle both Locator objects and raw locator objects
-  const reactLocator = locator.locator || locator
-  let _locator = `_react=${reactLocator.react}`;
-  let props = '';
-
-  if (reactLocator.props) {
-    props += propBuilder(reactLocator.props);
-    _locator += props;
-  }
-  return matcher.locator(_locator).all();
-}
-
-async function findVue(matcher, locator) {
-  // Handle both Locator objects and raw locator objects
-  const vueLocator = locator.locator || locator
-  let _locator = `_vue=${vueLocator.vue}`;
-  let props = '';
-
-  if (vueLocator.props) {
-    props += propBuilder(vueLocator.props);
-    _locator += props;
-  }
-  return matcher.locator(_locator).all();
-}
-
-async function findByPlaywrightLocator(matcher, locator) {
-  // Handle both Locator objects and raw locator objects
-  const pwLocator = locator.locator || locator
-  if (pwLocator && pwLocator.toString && pwLocator.toString().includes(process.env.testIdAttribute)) {
-    return matcher.getByTestId(pwLocator.pw.value.split('=')[1]);
-  }
-  const pwValue = typeof pwLocator.pw === 'string' ? pwLocator.pw : pwLocator.pw
-  return matcher.locator(pwValue).all();
-}
-
-function propBuilder(props) {
-  let _props = '';
-
-  for (const [key, value] of Object.entries(props)) {
-    if (typeof value === 'object') {
-      for (const [k, v] of Object.entries(value)) {
-        _props += `[${key}.${k} = "${v}"]`;
-      }
-    } else {
-      _props += `[${key} = "${value}"]`;
-    }
-  }
-  return _props;
-}
-
-export { findReact, findVue, findByPlaywrightLocator };