codeceptjs 2.6.7 → 2.6.11

package/translations/fr-FR.js

@@ -0,0 +1,63 @@
+module.exports = {
+  I: 'Je',
+  contexts: {
+    Feature: 'Fonctionnalité',
+    Scenario: 'Scénario',
+    Before: 'Avant',
+    After: 'Après',
+    BeforeSuite: 'AvantLaSuite',
+    AfterSuite: 'AprèsLaSuite',
+  },
+  actions: {
+    amOutsideAngularApp: 'suisALExtérieurDeLApplicationAngular',
+    amInsideAngularApp: 'suisALIntérieurDeLApplicationAngular',
+    waitForElement: 'attendsLElément',
+    waitForClickable: 'attends',
+    waitForVisible: 'attendsPourVoir',
+    waitForText: 'attendsLeTexte',
+    moveTo: 'vaisSur',
+    refresh: 'rafraîchis',
+    haveModule: 'ajouteLeModule',
+    resetModule: 'réinitialiseLeModule',
+    amOnPage: 'suisSurLaPage',
+    click: 'cliqueSur',
+    doubleClick: 'doubleCliqueSur',
+    see: 'vois',
+    dontSee: 'neVoisPas',
+    selectOption: 'sélectionneUneOption',
+    fillField: 'remplisLeChamp',
+    pressKey: 'appuisSurLaTouche',
+    triggerMouseEvent: 'déclencheLEvénementDeLaSouris',
+    attachFile: 'attacheLeFichier',
+    seeInField: 'voisDansLeChamp',
+    dontSeeInField: 'neVoisPasDansLeChamp',
+    appendField: 'ajouteAuChamp',
+    checkOption: 'vérifieLOption',
+    seeCheckboxIsChecked: 'voisQueLaCaseEstCochée',
+    dontSeeCheckboxIsChecked: 'neVoisPasQueLaCaseEstCochée',
+    grabTextFrom: 'prendsLeTexteDe',
+    grabValueFrom: 'prendsLaValeurDe',
+    grabAttributeFrom: 'prendsLAttributDe',
+    seeInTitle: 'voisDansLeTitre',
+    dontSeeInTitle: 'neVoisPasDansLeTitre',
+    grabTitle: 'prendsLeTitre',
+    seeElement: 'voisLElément',
+    dontSeeElement: 'neVoisPasLElément',
+    seeInSource: 'voisDansLeCodeSource',
+    dontSeeInSource: 'neVoisPasDansLeCodeSource',
+    executeScript: 'exécuteUnScript',
+    executeAsyncScript: 'exécuteUnScriptAsynchrone',
+    seeInCurrentUrl: 'voisDansLUrl',
+    dontSeeInCurrentUrl: 'neVoisPasDansLUrl',
+    seeCurrentUrlEquals: 'voisQueLUrlEstEgaleA',
+    dontSeeCurrentUrlEquals: 'neVoisPasQueLUrlEstEgaleA',
+    saveScreenshot: 'prendsUneCapture',
+    setCookie: 'déposeLeCookie',
+    clearCookie: 'effaceLeCookie',
+    seeCookie: 'voisLeCookie',
+    dontSeeCookie: 'neVoisPasLeCookie',
+    grabCookie: 'prendsLeCookie',
+    resizeWindow: 'redimensionneLaFenêtre',
+    wait: 'attends',
+  },
+};

package/translations/index.js

@@ -1,8 +1,9 @@
-exports['pt-BR'] = require('./pt-BR');
-exports['ru-RU'] = require('./ru-RU');
+exports['de-DE'] = require('./de-DE');
 exports['it-IT'] = require('./it-IT');
+exports['fr-FR'] = require('./fr-FR');
+exports['ja-JP'] = require('./ja-JP');
 exports['pl-PL'] = require('./pl-PL');
+exports['pt-BR'] = require('./pt-BR');
+exports['ru-RU'] = require('./ru-RU');
 exports['zh-CN'] = require('./zh-CN');
 exports['zh-TW'] = require('./zh-TW');
-exports['ja-JP'] = require('./ja-JP');
-exports['de-DE'] = require('./de-DE');

package/typings/types.d.ts

@@ -1848,6 +1848,40 @@ declare namespace CodeceptJS {
          * Reload the page
          */
         refresh(): void;
+        /**
+         * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+         * Filename is relative to output folder.
+         *
+         * ```js
+         * I.saveElementScreenshot(`#submit`,'debug.png');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param fileName - file name to save.
+         */
+        saveElementScreenshot(locator: string | any, fileName: string): void;
+        /**
+         * Grab the width, height, location of given locator.
+         * Provide `width` or `height`as second param to get your desired prop.
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * Returns an object with `x`, `y`, `width`, `height` keys.
+         *
+         * ```js
+         * const value = await I.grabElementBoundingRect('h3');
+         * // value is like { x: 226.5, y: 89, width: 527, height: 220 }
+         * ```
+         *
+         * To get only one metric use second parameter:
+         *
+         * ```js
+         * const width = await I.grabElementBoundingRect('h3', 'width');
+         * // width == 527
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param elementSize - x, y, width or height of the given element.
+         * @returns Element bounding rectangle
+         */
+        grabElementBoundingRect(locator: string | any, elementSize: string): any;
         /**
          * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
          * Filename is relative to output folder.
@@ -2471,9 +2505,28 @@ declare namespace CodeceptJS {
          * @param key - key or array of keys to press.
          *
          *
-         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Playwright#1313](https://github.com/GoogleChrome/Playwright/issues/1313)).
+         * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
          */
         pressKey(key: string | string[]): void;
+        /**
+         * 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']);
+         * ```
+         * @param key - or array of keys to type.
+         * @param [delay = null] - (optional) delay in ms between key presses
+         */
+        type(key: string | string[], delay?: number): void;
         /**
          * Fills a text field or textarea, after clearing its value, with the given string.
          * Field is located by name, label, CSS, or XPath.
@@ -2904,6 +2957,17 @@ declare namespace CodeceptJS {
          * @returns attribute value
          */
         grabAttributeFrom(locator: CodeceptJS.LocatorOrString, attr: string): Promise<string>;
+        /**
+         * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+         * Filename is relative to output folder.
+         *
+         * ```js
+         * I.saveElementScreenshot(`#submit`,'debug.png');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param fileName - file name to save.
+         */
+        saveElementScreenshot(locator: string | any, fileName: string): void;
         /**
          * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
          * Filename is relative to output folder.
@@ -3100,7 +3164,7 @@ declare namespace CodeceptJS {
         /**
          * Waits for navigation to finish. By default takes configured `waitForNavigation` option.
          *
-         * See [Pupeteer's reference](https://github.com/GoogleChrome/Playwright/blob/master/docs/api.md#pagewaitfornavigationoptions)
+         * See [Pupeteer's reference](https://github.com/microsoft/Playwright/blob/master/docs/api.md#pagewaitfornavigationoptions)
          */
         waitForNavigation(opts: any): void;
         /**
@@ -3867,6 +3931,17 @@ declare namespace CodeceptJS {
          * @param url - value to check.
          */
         dontSeeCurrentUrlEquals(url: string): void;
+        /**
+         * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+         * Filename is relative to output folder.
+         *
+         * ```js
+         * I.saveElementScreenshot(`#submit`,'debug.png');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param fileName - file name to save.
+         */
+        saveElementScreenshot(locator: string | any, fileName: string): void;
         /**
          * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
          * Filename is relative to output folder.
@@ -4906,6 +4981,25 @@ declare namespace CodeceptJS {
          * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
          */
         pressKey(key: string | string[]): void;
+        /**
+         * 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']);
+         * ```
+         * @param key - or array of keys to type.
+         * @param [delay = null] - (optional) delay in ms between key presses
+         */
+        type(key: string | string[], delay?: number): void;
         /**
          * Fills a text field or textarea, after clearing its value, with the given string.
          * Field is located by name, label, CSS, or XPath.
@@ -5393,6 +5487,17 @@ declare namespace CodeceptJS {
          * {{ react }}
          */
         grabAttributeFrom(locator: CodeceptJS.LocatorOrString, attr: string): Promise<string>;
+        /**
+         * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+         * Filename is relative to output folder.
+         *
+         * ```js
+         * I.saveElementScreenshot(`#submit`,'debug.png');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param fileName - file name to save.
+         */
+        saveElementScreenshot(locator: string | any, fileName: string): void;
         /**
          * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
          * Filename is relative to output folder.
@@ -6160,6 +6265,17 @@ declare namespace CodeceptJS {
          * @param value - to check.
          */
         dontSeeInSource(value: string): void;
+        /**
+         * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+         * Filename is relative to output folder.
+         *
+         * ```js
+         * I.saveElementScreenshot(`#submit`,'debug.png');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param fileName - file name to save.
+         */
+        saveElementScreenshot(locator: string | any, fileName: string): void;
         /**
          * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
          * Filename is relative to output folder.
@@ -7256,6 +7372,17 @@ declare namespace CodeceptJS {
          * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
          */
         moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
+        /**
+         * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+         * Filename is relative to output folder.
+         *
+         * ```js
+         * I.saveElementScreenshot(`#submit`,'debug.png');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @param fileName - file name to save.
+         */
+        saveElementScreenshot(locator: string | any, fileName: string): void;
         /**
          * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
          * Filename is relative to output folder.
@@ -7447,19 +7574,24 @@ declare namespace CodeceptJS {
          */
         pressKey(key: string | string[]): void;
         /**
-         * Types out the given string or the array of keys provided.
-         * _Note:_ Should only be used when using [`fillField`](#fillfield) is not an option.
+         * 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
-         * // When passing in a string
+         * // passing in a string
          * I.type('Type this out.');
-         * // When passing in an array
+         *
+         * // typing values with a 100ms interval
+         * I.type('4141555311111111', 100);
+         *
+         * // passing in an array
          * I.type(['T', 'E', 'X', 'T']);
          * ```
          * @param key - or array of keys to type.
-         * Type out given array of keys or a string of text
+         * @param [delay = null] - (optional) delay in ms between key presses
          */
-        type(key: string | string[]): void;
+        type(key: string | string[], delay?: number): void;
         /**
          * Resize the current window to provided width and height.
          * First parameter can be set to `maximize`.

package/docs/wiki/Release-process.md

@@ -1,25 +0,0 @@
-This is the guide for maintainers:
-
-## Release Process
-
-1. pull in the latest changes from master
-2. create branch `release-x.x.x` and switch to it `git checkout -b release-x.x.x`
-3. update version in `package.json`
-4. go through commits in this release and write a changelog. 
-  * Changelog should be written not for robots! 
-  * Use simple wording explaining what a change was, how to use a new feature (maybe with a code example), and mention a related issue. 
-  * When using `#123` a link for issue #123 will be automatically added. 
-  * A contributor must be mentioned. We use GitHub names with `@` prefix. A link to user profile is automatically added.
-5. run `./runio.js docs` to build documentation
-6. commit all changes, push, and make PR
-7. check that all tests pass and merge your PR
-8. run `./runio.js release` to publish latest release. A website will be updated.
-  * to update version for patch release: `./runio.js release patch`
-  * to update version for minor release: `./runio.js release minor`
-9. Post announcements in Twitter & Slack
-
-## Updating a website
-
-* Run `./runio.js docs:helpers` to build docs from helpers
-* Run `./runio.js publish:site` to update a website
-