@uuv/playwright 3.36.0 → 3.37.0

package/src/cucumber/step_definitions/playwright/generated/_en-generated-cucumber-steps-definition.ts

@@ -20,7 +20,7 @@ import { DEFAULT_TIMEOUT, fs, KEY_PRESS } from "@uuv/runner-commons";
 import { checkA11y, injectAxe } from "axe-playwright";
 import { devices, expect } from "@playwright/test";
 import { Locator, Page } from "playwright";
-import { DataTable, Given, Then, When } from "@cucumber/cucumber";
+import { DataTable } from "@cucumber/cucumber";
 import {
     addCookie,
     click,
@@ -41,14 +41,14 @@ import {
     withinRoleAndName,
     getTimeout
 } from "../core-engine";
-import { World } from "../../../preprocessor/run/world";
+import { World, Given, Then, When } from "../../../preprocessor/run/world";
 import { ContextObject, RunOptions } from "axe-core";
 import path from "path";
 
 /**
  * Sets the viewport dimensions with one of the presets defined by your runtime engine as Cypress: [Link](https://docs.cypress.io/api/commands/viewport#Arguments) or Playwright: [Link](https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/server/deviceDescriptorsSource.json)
  * */
-Given(`I set viewport to preset {string}`, async function(this: World, viewportPreset: string) {
+Given(`I set viewport to preset {string}`, async function(viewportPreset: string) {
   await this.page.setViewportSize(devices[viewportPreset].viewport);
 });
 
@@ -57,7 +57,7 @@ Given(`I set viewport to preset {string}`, async function(this: World, viewportP
  * */
 Given(
  `I set viewport with width {int} and height {int}`, async function
- (this: World, width: number, height: number) {
+ (width: number, height: number) {
    await this.page.setViewportSize({ width: width, height: height });
  }
 );
@@ -67,7 +67,7 @@ Given(
  * */
 Given(
  `I start a keyboard navigation from the top of the page`,
- async function(this: World) {
+ async function() {
    await this.page.mouse.click(0.5, 0.5);
  }
 );
@@ -75,7 +75,7 @@ Given(
 /**
  * Navigate to the Uri passed as a argument (full url consisting of the BASE_URL + Uri) or navigate to Url if begin with http:// or https://
  * */
-Given(`I visit path {string}`, { timeout: 60 * 1000 }, async function(this: World, siteUrl: string) {
+Given(`I visit path {string}`, async function(siteUrl: string) {
   await deleteCookieByName(this, COOKIE_NAME.SELECTED_ELEMENT);
   await this.page.goto(`${siteUrl}`);
 });
@@ -83,7 +83,7 @@ Given(`I visit path {string}`, { timeout: 60 * 1000 }, async function(this: Worl
 /**
  * Triggers a click on the selected element.<br/>Make sure you've selected an element beforehand with the <strong>within...</strong> phrases.
  * */
-When(`I click`, async function(this: World) {
+When(`I click`, async function() {
   const keyBoardFocusTargetObj = keyBoardFocusTarget(this);
   if ((await keyBoardFocusTargetObj.count()) === 1) {
     await keyBoardFocusTargetObj.click({ timeout: DEFAULT_TIMEOUT });
@@ -95,7 +95,7 @@ When(`I click`, async function(this: World) {
 /**
  * Triggers a click on the element with given role and specific name
  * */
-When(`I click on element with role {string} and name {string}`, async function(this: World, role: string, name: string) {
+When(`I click on element with role {string} and name {string}`, async function(role: string, name: string) {
   await click(this, role, name);
 });
 
@@ -103,7 +103,7 @@ When(`I click on element with role {string} and name {string}`, async function(t
 /**
  * Selects the element whose aria-label is specified <br />⚠ remember to deselect the element with <b>[I reset context](#i-reset-context)</b> if you're no longer acting on it
  * */
-When(`within the element with aria-label {string}`, async function(this: World, expectedAriaLabel: string) {
+When(`within the element with aria-label {string}`, async function(expectedAriaLabel: string) {
   const sanitizedExpectedAriaLabel = encodeURIComponent(expectedAriaLabel).replaceAll("%20", " ");
   await getPageOrElement(this).then(async (element) => {
     const locator = element.getByLabel(sanitizedExpectedAriaLabel, { exact: true });
@@ -116,7 +116,7 @@ When(`within the element with aria-label {string}`, async function(this: World,
 /**
  * Deletes selected element and timeout
  * */
-When(`I reset context`, async function(this: World) {
+When(`I reset context`, async function() {
   await deleteCookieByName(this, COOKIE_NAME.SELECTED_ELEMENT);
   await deleteCookieByName(this, COOKIE_NAME.TIMEOUT);
   const keyBoardFocusTargetObj = keyBoardFocusTarget(this);
@@ -128,7 +128,7 @@ When(`I reset context`, async function(this: World) {
 /**
  * Selects the element whose selector is specified <br />⚠ remember to deselect the element with <b>[I reset context](#i-reset-context)</b> if you're no longer acting on it
  * */
-When(`within the element with selector {string}`, async function(this: World, selector: string) {
+When(`within the element with selector {string}`, async function(selector: string) {
   await getPageOrElement(this).then(async (element) => {
     const locator = element.locator(selector);
     await expect(locator).toHaveCount(1, { timeout: await getTimeout(this) });
@@ -140,21 +140,21 @@ When(`within the element with selector {string}`, async function(this: World, se
 /**
  * Writes the sentence passed as a parameter (useful for example to fill in a form field).<br/>Make sure you've selected an element beforehand with the <strong>within...</strong> phrases.
  * */
-When(`I type the sentence {string}`, async function(this: World, textToType: string) {
+When(`I type the sentence {string}`, async function(textToType: string) {
     await type(this, textToType);
 });
 
 /**
  * Writes the sentence passed as a parameter (useful for example to fill in a form field).<br/>Make sure you've selected an element beforehand with the <strong>within...</strong> phrases.
  * */
-When(`I enter the value {string}`, async function(this: World, textToType: string) {
+When(`I enter the value {string}`, async function(textToType: string) {
     await type(this, textToType);
 });
 
 /**
  * Press specified key multiple times using | as: num|{key}
  * */
-When(`I press {int} times on {string}`, async function(this: World, nbTimes: number, key: string) {
+When(`I press {int} times on {string}`, async function(nbTimes: number, key: string) {
   for (let i = 1; i <= nbTimes; i++) {
     await pressKey(this, key);
   }
@@ -163,42 +163,42 @@ When(`I press {int} times on {string}`, async function(this: World, nbTimes: num
 /**
  * Press specified key: <table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody><tr><td>{tab}</td><td>Tabulation</td></tr><tr><td>{reverseTab}</td><td>Reverse tabulation</td></tr><tr><td>{down}</td><td>Arrow Down</td></tr><tr><td>{right}</td><td>Arrow Right</td></tr><tr><td>{left}</td><td>Arrow Left</td></tr><tr><td>{up}</td><td>Arrow Up</td></tr></tbody></table><br/>Make sure you've selected an element beforehand with the <strong>within...</strong> phrases.
  * */
-When(`I press {string}`, async function(this: World, key: string) {
+When(`I press {string}`, async function(key: string) {
   await pressKey(this, key);
 });
 
 /**
  * Move to the previous html element that can be reached with back Tab<br/><a target='_blank' href='https://github.com/e2e-test-quest/uuv/blob/main/example/en-keyboard.feature'>Examples</a>
  * */
-When(`I go to previous keyboard element`, async function(this: World) {
+When(`I go to previous keyboard element`, async function() {
   await this.page.keyboard.press("ShiftLeft+Tab");
 });
 
 /**
  * Move to the next html element that can be reached with Tab<br/><a target='_blank' href='https://github.com/e2e-test-quest/uuv/blob/main/example/en-keyboard.feature'>Examples</a>
  * */
-When(`I go to next keyboard element`, async function(this: World) {
+When(`I go to next keyboard element`, async function() {
   await this.page.keyboard.press("Tab");
 });
 
 /**
  * Sets the timeout value (in millisecond) for finding element in the DOM <br />⚠ remember to deselect the element with <b>[I reset context](#i-reset-context)</b> if you're no longer acting on it
  * */
-When(`I set timeout with value {int}`, async function(this: World, newTimeout: number) {
+When(`I set timeout with value {int}`, async function(newTimeout: number) {
   await addCookie(this, COOKIE_NAME.TIMEOUT, new TimeoutCookie("timeout", newTimeout));
 });
 
 /**
  * Selects the element whose [accessible role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles#aria_role_types) and accessible [name](https://russmaxdesign.github.io/html-elements-names/) are specified <br />⚠ remember to deselect the element with <b>[I reset context](#i-reset-context)</b> if you're no longer acting on it
  * */
-When(`within the element with role {string} and name {string}`, async function(this: World, role: string, name: string) {
+When(`within the element with role {string} and name {string}`, async function(role: string, name: string) {
   await withinRoleAndName(this, role, name);
 });
 
 /**
  * Selects the element whose data-testId attribute is specified <br />⚠ remember to deselect the element with <b>[I reset context](#i-reset-context)</b> if you're no longer acting on it
  * */
-When(`within the element with testId {string}`, async function(this: World, testId: string) {
+When(`within the element with testId {string}`, async function(testId: string) {
   testId = encodeURIComponent(testId);
   await getPageOrElement(this).then(async (element) => {
     const locator = element.getByTestId(testId);
@@ -213,7 +213,7 @@ When(`within the element with testId {string}`, async function(this: World, test
  * */
 When(
  `I mock a request {} on url {string} named {string} with content {}`,
- async function(this: World, verb: string, url: string, name: string, body: any) {
+ async function(verb: string, url: string, name: string, body: any) {
    await addCookie(this, COOKIE_NAME.MOCK_URL, new MockCookie(name, url, verb));
    await this.page.route(url, async route => {
      await route.fulfill({ body });
@@ -227,7 +227,7 @@ When(
  * */
 When(
  `I mock a request {} on url {string} named {string} with status code {int}`,
- async function(this: World, verb: string, url: string, name: string, statusCode: number) {
+ async function(verb: string, url: string, name: string, statusCode: number) {
    await addCookie(this, COOKIE_NAME.MOCK_URL, new MockCookie(name, url, verb));
    await this.page.route(url, async route => {
      await route.fulfill({ status: statusCode });
@@ -241,7 +241,7 @@ When(
  * */
 When(
  `I mock a request {} on url {string} named {string} with fixture {}`,
- async function(this: World, verb: string, url: string, name: string, fixture: any) {
+ async function(verb: string, url: string, name: string, fixture: any) {
    await addCookie(this, COOKIE_NAME.MOCK_URL, new MockCookie(name, url, verb));
    const data = fs.readFileSync(path.join(getConfigDir(), `playwright/fixtures/${fixture}`), "utf8");
    await this.page.route(url, async route => {
@@ -255,7 +255,7 @@ When(
 /**
  * Checks that an Html element exists with the specified selector
  * */
-Then(`I should see an element with selector {string}`, async function(this: World, selector: string) {
+Then(`I should see an element with selector {string}`, async function(selector: string) {
   await getPageOrElement(this).then(async (element) => expect(element.locator(selector)).toHaveCount(1, { timeout: await getTimeout(this) }));
 });
 
@@ -264,7 +264,7 @@ Then(`I should see an element with selector {string}`, async function(this: Worl
  * */
 When(
  `I set header(s) for uri {string} and method {string}`,
- async function(this: World, url: string, method: string, headersToSet: DataTable) {
+ async function(url: string, method: string, headersToSet: DataTable) {
    await this.page.route(url, async route => {
      const headers = route.request().headers();
      await route.continue({ headers: { ...headers, ...headersToSet.rowsHash() } });
@@ -277,7 +277,7 @@ When(
  * */
 When(
  `I set header(s) for uri {string}`,
- async function(this: World, url: string, headersToSet: DataTable) {
+ async function(url: string, headersToSet: DataTable) {
    await this.page.route(url, async route => {
      const headers = route.request().headers();
      await route.continue({ headers: { ...headers, ...headersToSet.rowsHash() } });
@@ -288,14 +288,14 @@ When(
 /**
  * Checks that an Html element exists with the specified [accessible role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles#aria_role_types) and [name](https://russmaxdesign.github.io/html-elements-names/)
  * */
-Then(`I should see an element with role {string} and name {string}`, async function(this: World, role: string, name: string) {
+Then(`I should see an element with role {string} and name {string}`, async function(role: string, name: string) {
   await findWithRoleAndName(this, role, name);
 });
 
 /**
  * Checks that an Html element exists with the specified content
  * */
-Then(`I should see an element with content {string}`, async function(this: World, textContent: string) {
+Then(`I should see an element with content {string}`, async function(textContent: string) {
   // TODO partie pris de faire en exactitude. A voir si on doit faire 2 phrases https://playwright.dev/docs/api/class-locator#locator-get-by-text
   await getPageOrElement(this).then(async (element) => expect(element.getByText(textContent, { exact: true })).toHaveCount(1, { timeout: await getTimeout(this) }));
 });
@@ -303,14 +303,14 @@ Then(`I should see an element with content {string}`, async function(this: World
 /**
  * Checks that an Html element does not exists with the specified content
  * */
-Then(`I should not see an element with content {string}`, async function(this: World, textContent: string) {
+Then(`I should not see an element with content {string}`, async function(textContent: string) {
   await getPageOrElement(this).then(async (element) => expect(element.getByText(textContent, { exact: true })).toHaveCount(0, { timeout: await getTimeout(this) }));
 });
 
 /**
  * Checks that an Html element exists with the specified data-testid attribute
  * */
-Then(`I should see an element with testId {string}`, async function(this: World, testId: string) {
+Then(`I should see an element with testId {string}`, async function(testId: string) {
   testId = encodeURIComponent(testId);
   await getPageOrElement(this).then(async (element) => expect(element.getByTestId(testId, { exact: true })).toHaveCount(1, { timeout: await getTimeout(this) }));
 });
@@ -318,7 +318,7 @@ Then(`I should see an element with testId {string}`, async function(this: World,
 /**
  * Checks that an Html element does not exists with the specified data-testid attribute
  * */
-Then(`I should not see an element with testId {string}`, async function(this: World, testId: string) {
+Then(`I should not see an element with testId {string}`, async function(testId: string) {
   testId = encodeURIComponent(testId);
   await getPageOrElement(this).then(async (element) => expect(element.getByTestId(testId, { exact: true })).toHaveCount(0, { timeout: await getTimeout(this) }));
 });
@@ -328,7 +328,7 @@ Then(`I should not see an element with testId {string}`, async function(this: Wo
  * */
 Then(
  `I should not have any axe-core accessibility issue`,
- async function(this: World) {
+ async function() {
    await injectAxe(this.page as Page);
    await checkA11y(this.page as Page);
  });
@@ -338,7 +338,7 @@ Then(
  * */
 Then(
  `I should not have any axe-core accessibility issue with option json fixture {}`,
- async function(this: World, option: any) {
+ async function(option: any) {
    await injectAxe(this.page as Page);
    const optionFile = await fs.readFileSync(path.join(getConfigDir(), `playwright/fixtures/${option}`));
    const optionJson = JSON.parse(optionFile.toString());
@@ -357,7 +357,7 @@ function getConfigDir(): string {
  * */
 Then(
  `I should not have any axe-core accessibility issue with context json fixture {} and option json fixture {}`,
- async function(this: World, context: any, option: any) {
+ async function(context: any, option: any) {
    await injectAxe(this.page as Page);
    const contextFile = await fs.readFileSync(path.join(getConfigDir(), `playwright/fixtures/${context}`));
    const optionFile = await fs.readFileSync(path.join(getConfigDir(), `playwright/fixtures/${option}`));
@@ -372,7 +372,7 @@ Then(
  * */
 Then(
  `I should not have any axe-core critical accessibility issue`,
- async function(this: World) {
+ async function() {
    await injectAxe(this.page as Page);
    await checkA11y(this.page as Page, undefined, {
      includedImpacts: ["critical"]
@@ -384,7 +384,7 @@ Then(
  * */
 Then(
  `I should not have any axe-core accessibility issue with {} impact(s)`,
- async function(this: World, impacts: any) {
+ async function(impacts: any) {
    await injectAxe(this.page as Page);
    await checkA11y(this.page as Page, undefined, {
      includedImpacts: [impacts]
@@ -396,7 +396,7 @@ Then(
  * */
 Then(
  `I should not have any axe-core accessibility issue with accessibility standard(s) {}`,
- async function(this: World, tags: any) {
+ async function(tags: any) {
    await injectAxe(this.page as Page);
    await checkA11y(this.page as Page, undefined, {
      axeOptions: {
@@ -413,7 +413,7 @@ Then(
  * */
 Then(
  `I should not see an element with role {string} and name {string}`,
- async function(this: World, role: string, name: string) {
+ async function(role: string, name: string) {
    await notFoundWithRoleAndName(this, role, name);
  }
 );
@@ -423,7 +423,7 @@ Then(
  * */
 Then(
  `I should see an element with role {string} and name {string} and content {string}`,
- async function(this: World, expectedRole: string, name: string, expectedTextContent: string) {
+ async function(expectedRole: string, name: string, expectedTextContent: string) {
    await findWithRoleAndNameAndContent(this, expectedRole, name, expectedTextContent);
  }
 );
@@ -433,7 +433,7 @@ Then(
  * */
 Then(
  `the element with role {string} and name {string} should be keyboard focused`,
- async function(this: World, expectedRole: string, name: string) {
+ async function(expectedRole: string, name: string) {
    await findWithRoleAndNameFocused(this, expectedRole, name);
  }
 );
@@ -443,7 +443,7 @@ Then(
  * */
 Then(
  `the element with selector {string} should be keyboard focused`,
- async function(this: World, selector: string) {
+ async function(selector: string) {
    await getPageOrElement(this).then(async (element) => {
      const locator = element.locator(selector);
      await locator.focus({ timeout: 10000 });
@@ -457,7 +457,7 @@ Then(
  * */
 Then(
  `I should see an element with role {string} and name {string} and content {string} disabled`,
- async function(this: World, expectedRole: string, name: string, expectedTextContent: string) {
+ async function(expectedRole: string, name: string, expectedTextContent: string) {
    await findWithRoleAndNameAndContentDisable(this, expectedRole, name, expectedTextContent);
  }
 );
@@ -467,7 +467,7 @@ Then(
  * */
 Then(
  `I should see an element with role {string} and name {string} and content {string} not disabled`,
- async function(this: World, expectedRole: string, name: string, expectedTextContent: string) {
+ async function(expectedRole: string, name: string, expectedTextContent: string) {
    await findWithRoleAndNameAndContentEnable(this, expectedRole, name, expectedTextContent);
  }
 );
@@ -475,7 +475,7 @@ Then(
 /**
  * Checks that an Html element exists with the specified aria-label attribute
  * */
-Then(`I should see an element with aria-label {string}`, async function(this: World, expectedAriaLabel: string) {
+Then(`I should see an element with aria-label {string}`, async function(expectedAriaLabel: string) {
   expectedAriaLabel = encodeURIComponent(expectedAriaLabel);
   await getPageOrElement(this).then(async (element) => expect(element.getByLabel(expectedAriaLabel, { exact: true })).toHaveCount(1, { timeout: await getTimeout(this) }));
 });
@@ -483,7 +483,7 @@ Then(`I should see an element with aria-label {string}`, async function(this: Wo
 /**
  * Checks that an Html element does not exists with the specified aria-label attribute
  * */
-Then(`I should not see an element with aria-label {string}`, async function(this: World, expectedAriaLabel: string) {
+Then(`I should not see an element with aria-label {string}`, async function(expectedAriaLabel: string) {
   expectedAriaLabel = encodeURIComponent(expectedAriaLabel);
   await getPageOrElement(this).then(async (element) => expect(element.getByLabel(expectedAriaLabel, { exact: true })).toHaveCount(0, { timeout: await getTimeout(this) }));
 });
@@ -491,7 +491,7 @@ Then(`I should not see an element with aria-label {string}`, async function(this
 /**
  * Checks that an Html element exists with the specified aria-label attribute and content
  * */
-Then(`I should see an element with aria-label {string} and content {string}`, async function(this: World, expectedAriaLabel: string, expectedTextContent: string) {
+Then(`I should see an element with aria-label {string} and content {string}`, async function(expectedAriaLabel: string, expectedTextContent: string) {
   expectedAriaLabel = encodeURIComponent(expectedAriaLabel);
   await getPageOrElement(this).then(async (element) => {
     const byLabel = element.getByLabel(expectedAriaLabel, { exact: true });
@@ -503,7 +503,7 @@ Then(`I should see an element with aria-label {string} and content {string}`, as
 /**
  * Move to the previous html element that can be reached with Tab and checks that the Html element with the specified [accessible role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles#aria_role_types) and [name](https://russmaxdesign.github.io/html-elements-names/) is focused<br/><a target='_blank' href='https://github.com/e2e-test-quest/uuv/blob/main/example/en-keyboard.feature'>Examples</a>
  * */
-When(`the previous keyboard element focused should have name {string} and role {string}`, async function(this: World, expectedRole: string, name: string) {
+When(`the previous keyboard element focused should have name {string} and role {string}`, async function(expectedRole: string, name: string) {
   await this.page.keyboard.press("ShiftLeft+Tab");
   await findWithRoleAndNameFocused(this, expectedRole, name);
 });
@@ -511,7 +511,7 @@ When(`the previous keyboard element focused should have name {string} and role {
 /**
  * "Move to the next html element that can be reached with Tab and checks that the Html element with the specified [accessible role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles#aria_role_types) and [name](https://russmaxdesign.github.io/html-elements-names/) is focused<br/><a target='_blank' href='https://github.com/e2e-test-quest/uuv/blob/main/example/en-keyboard.feature'>Examples</a>
  * */
-When(`the next keyboard element focused should have name {string} and role {string}`, async function(this: World, expectedRole: string, name: string) {
+When(`the next keyboard element focused should have name {string} and role {string}`, async function(expectedRole: string, name: string) {
   await this.page.keyboard.press("Tab");
   await findWithRoleAndNameFocused(this, expectedRole, name);
 });
@@ -520,7 +520,7 @@ When(`the next keyboard element focused should have name {string} and role {stri
 /**
  * Wait that a named mock has been consumed until timeout
  * */
-Then(`I should consume a mock named {string}`, async function(this: World, name: string) {
+Then(`I should consume a mock named {string}`, async function(name: string) {
   const cookie = await getCookie(this, COOKIE_NAME.MOCK_URL);
   expect(() => {
     if (!cookie.isValid()) {
@@ -542,7 +542,7 @@ Then(`I should consume a mock named {string}`, async function(this: World, name:
 /**
  * Wait milliseconds. <b>Warning:</b> use this sentence <b>in production</b> can make your <b>test flaky</b>.
  * */
-Then(`I wait {int} ms`, async function(this: World, ms: number) {
+Then(`I wait {int} ms`, async function(ms: number) {
   await this.page.waitForTimeout(ms);
 });
 
@@ -551,7 +551,7 @@ Then(`I wait {int} ms`, async function(this: World, ms: number) {
  * */
 Then(
  `I should see these attributes with values`,
- async function(this: World, expectedAttributeList: DataTable) {
+ async function(expectedAttributeList: DataTable) {
    await getPageOrElement(this).then(async (element) => {
      // console.debug("expectedAttributeList.raw(),", expectedAttributeList.raw())
      for (const expectedAttribute of expectedAttributeList.raw()) {
@@ -569,7 +569,7 @@ Then(
  * */
 Then(
  `I should see a list named {string} and containing`,
- async function(this: World, expectedListName: string, expectedElementsOfList: DataTable) {
+ async function(expectedListName: string, expectedElementsOfList: DataTable) {
    await withinRoleAndName(this, "list", expectedListName);
    await getPageOrElement(this).then(async (element) => {
      const listitem = await element.getByRole("listitem", { exact: true }).all();
@@ -618,7 +618,7 @@ function keyBoardFocusTarget(world: World) {
   return world.page.locator(":focus");
 }
 
-async function setMockAsConsumed(name: string, mock: MockCookie, world: World<any>) {
+async function setMockAsConsumed(name: string, mock: MockCookie, world: World) {
   const newMockCookie = new MockCookie(name, mock.url, mock.verb);
   newMockCookie.isConsumed = true;
   await addCookie(world, COOKIE_NAME.MOCK_URL, newMockCookie);