@uuv/cypress 2.57.0 → 2.58.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.58.0](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v2.57.0...runner-cypress-v2.58.0) (2025-07-01)
+
+
+### Features
+
+* add grid and table sentences, [#1029](https://github.com/e2e-test-quest/uuv/issues/1029) ([97f7330](https://github.com/e2e-test-quest/uuv/commit/97f7330a50926a872275c4f5ad026920174a9592))
+
 # [2.57.0](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v2.56.0...runner-cypress-v2.57.0) (2025-06-08)
 
 

package/dist/cucumber/step_definitions/cypress/_.common.d.ts

@@ -14,11 +14,14 @@ import { ByRoleOptions } from "@testing-library/cypress";
 import { Context } from "./_context";
 import Chainable = Cypress.Chainable;
 import { A11yReferenceEnum } from "@uuv/a11y";
+import { DataTable } from "@badeball/cypress-cucumber-preprocessor";
 export declare const shouldGenerateA11yReport: () => boolean;
 export declare const getA11yResultFilePath: () => string;
 export declare const uuvGetContext: () => Chainable<Context>;
 export declare function uuvCheckContextWithinFocusedElement(dontThrowError?: boolean): Cypress.Chainable<Context>;
 export declare function uuvPatchContext(partOfContext: any): Cypress.Chainable<Context>;
+export declare function removeHeaderSeparatorLine(pExpectedElementsOfList: DataTable): string[][];
+export declare function expectTableToHaveContent(expectedElementsOfList: string[][], cellAccessibleRole: string): void;
 export declare function uuvFindAllByRole(role: string, roleOptions: ByRoleOptions): Cypress.Chainable<JQuery<HTMLElement>>;
 export declare function uuvFindByRole(role: string, roleOptions: ByRoleOptions): Cypress.Chainable<JQuery<HTMLElement>>;
 export declare function uuvFindByLabelText(labelTextToSearch: string, roleOptions: ByRoleOptions): Cypress.Chainable<JQuery<HTMLElement>>;

package/dist/cucumber/step_definitions/cypress/_.common.js

@@ -15,6 +15,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.uuvGetContext = exports.getA11yResultFilePath = exports.shouldGenerateA11yReport = void 0;
 exports.uuvCheckContextWithinFocusedElement = uuvCheckContextWithinFocusedElement;
 exports.uuvPatchContext = uuvPatchContext;
+exports.removeHeaderSeparatorLine = removeHeaderSeparatorLine;
+exports.expectTableToHaveContent = expectTableToHaveContent;
 exports.uuvFindAllByRole = uuvFindAllByRole;
 exports.uuvFindByRole = uuvFindByRole;
 exports.uuvFindByLabelText = uuvFindByLabelText;
@@ -63,6 +65,27 @@ function addContextOptions(context, roleOptions) {
     };
     return Object.assign(roleOptions, retour);
 }
+function removeHeaderSeparatorLine(pExpectedElementsOfList) {
+    const expectedElementsOfList = pExpectedElementsOfList.raw();
+    if (expectedElementsOfList.length > 1) {
+        expectedElementsOfList.splice(1, 1);
+    }
+    return expectedElementsOfList;
+}
+function expectTableToHaveContent(expectedElementsOfList, cellAccessibleRole) {
+    const actualTableContent = [];
+    // eslint-disable-next-line cypress/unsafe-to-chain-command
+    cy.findAllByRole("row").each(($row, index) => {
+        const cellRole = index === 0 ? "columnheader" : cellAccessibleRole;
+        cy.findAllByRole(cellRole, { container: $row }).then(($cells) => {
+            const ligne = Array.from($cells, cell => cell.textContent?.trim() ?? "");
+            actualTableContent.push(ligne);
+        });
+    }).then(() => {
+        assert.equal(actualTableContent.length, expectedElementsOfList.length);
+        assert.deepEqual(actualTableContent, expectedElementsOfList, `Expected the table content ${JSON.stringify(actualTableContent)} to equals ${JSON.stringify(expectedElementsOfList)}`);
+    });
+}
 function abstractFindBy(callBackFunction, inputToSearch, inputOptions) {
     return cy.uuvGetContext().then(context => {
         // console.log(contextAlias, context);

package/dist/cucumber/step_definitions/cypress/generated/_en-generated-cucumber-steps-definition.js

@@ -385,6 +385,30 @@ const __common_1 = require("./../_.common");
         });
     });
 });
+/**
+ * Checks that there is a list with the specified [name](https://russmaxdesign.github.io/html-elements-names/) containing list items.<br/> <u>Example</u>\n```gherkin\nThen I should see a list named "test-list" and containing\n| First element   |\n| Second element  |\n| Third element   |\n```
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`I should see a grid named {string} and containing`, function (expectedListName, pExpectedElementsOfList) {
+    const expectedElementsOfList = (0, __common_1.removeHeaderSeparatorLine)(pExpectedElementsOfList);
+    cy.uuvFindByRole("grid", { name: expectedListName })
+        .uuvFoundedElement()
+        .should("exist")
+        .within(() => {
+        (0, __common_1.expectTableToHaveContent)(expectedElementsOfList, "gridcell");
+    });
+});
+/**
+ * Checks that there is a table with the specified [name](https://russmaxdesign.github.io/html-elements-names/) containing list items.<br/> <u>Example</u>\n```gherkin\nThen I should see a list named "test-list" and containing\n| First element   |\n| Second element  |\n| Third element   |\n```
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`I should see a table named {string} and containing`, function (expectedListName, pExpectedElementsOfList) {
+    const expectedElementsOfList = (0, __common_1.removeHeaderSeparatorLine)(pExpectedElementsOfList);
+    cy.uuvFindByRole("table", { name: expectedListName })
+        .uuvFoundedElement()
+        .should("exist")
+        .within(() => {
+        (0, __common_1.expectTableToHaveContent)(expectedElementsOfList, "cell");
+    });
+});
 /**
  * Checks Html attributes of the selected element
  * */

package/dist/cucumber/step_definitions/cypress/generated/_fr-generated-cucumber-steps-definition.js

@@ -385,6 +385,30 @@ const __common_1 = require("./../_.common");
         });
     });
 });
+/**
+ * Vérifie qu'il existe une liste avec le nom et les éléments de liste spécifiés.<br/> <u>Exemple</u>\n```gherkin\nAlors je dois voir une liste nommée "test-list" et contenant\n| Premier élément   |\n| Deuxième élément  |\n| Troisième élément   |\n```
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir une grille nommée {string} et contenant`, function (expectedListName, pExpectedElementsOfList) {
+    const expectedElementsOfList = (0, __common_1.removeHeaderSeparatorLine)(pExpectedElementsOfList);
+    cy.uuvFindByRole("grid", { name: expectedListName })
+        .uuvFoundedElement()
+        .should("exist")
+        .within(() => {
+        (0, __common_1.expectTableToHaveContent)(expectedElementsOfList, "gridcell");
+    });
+});
+/**
+ * Vérifie qu'il existe une liste avec le nom et les éléments de liste spécifiés.<br/> <u>Exemple</u>\n```gherkin\nAlors je dois voir une liste nommée "test-list" et contenant\n| Premier élément   |\n| Deuxième élément  |\n| Troisième élément   |\n```
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir un tableau nommé {string} et contenant`, function (expectedListName, pExpectedElementsOfList) {
+    const expectedElementsOfList = (0, __common_1.removeHeaderSeparatorLine)(pExpectedElementsOfList);
+    cy.uuvFindByRole("table", { name: expectedListName })
+        .uuvFoundedElement()
+        .should("exist")
+        .within(() => {
+        (0, __common_1.expectTableToHaveContent)(expectedElementsOfList, "cell");
+    });
+});
 /**
  * Vérifie des attributs Html de l'élément sélectionné
  * */

package/dist/cucumber/step_definitions/cypress/generated/enriched/fr/_fr-generated-steps-definition_table.js

@@ -22,19 +22,19 @@ const core_engine_1 = require("../../../core-engine");
 /**
  * Sélectionne l'élément ayant le rôle table et le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) sont spécifiés <br />⚠ pensez à déselectionner l'élement avec <b>[je reinitialise le contexte](#je-reinitialise-le-contexte)</b> si vous n'agissez plus dessus
  * */
-(0, cypress_cucumber_preprocessor_1.When)(`je vais à l'intérieur de la tableau nommée {string}`, function (name) {
+(0, cypress_cucumber_preprocessor_1.When)(`je vais à l'intérieur du tableau nommé {string}`, function (name) {
     (0, core_engine_1.withinRoleAndName)("table", name);
 });
 /**
  * Vérifie l'existence d'un élément Html ayant le rôle table et le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) spécifiés
  * */
-(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir une tableau nommée {string}`, function (name) {
+(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir un tableau nommé {string}`, function (name) {
     (0, core_engine_1.findWithRoleAndName)("table", name);
 });
 /**
  * Vérifie l'inexistence d'un élément Html ayant le rôle table et le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) spécifiés
  * */
-(0, cypress_cucumber_preprocessor_1.Then)(`je ne dois pas voir une tableau nommée {string}`, function (name) {
+(0, cypress_cucumber_preprocessor_1.Then)(`je ne dois pas voir un tableau nommé {string}`, function (name) {
     (0, core_engine_1.notFoundWithRoleAndName)("table", name);
 });
 // End of General Section
@@ -42,13 +42,13 @@ const core_engine_1 = require("../../../core-engine");
 /**
  * Saisie de la phrase passée en paramètre dans le champ spécifié (utile par exemple pour remplir un champ de formulaire).
  * */
-(0, cypress_cucumber_preprocessor_1.When)(`je saisie le(s) mot(s) {string} dans le tableau nommée {string}`, function (textToType, name) {
+(0, cypress_cucumber_preprocessor_1.When)(`je saisie le(s) mot(s) {string} dans le tableau nommé {string}`, function (textToType, name) {
     cy.uuvFindByRole("table", { name: name }).uuvFoundedElement().type(textToType);
 });
 /**
  * Saisie de la phrase passée en paramètre dans le champ spécifié (utile par exemple pour remplir un champ de formulaire).
  * */
-(0, cypress_cucumber_preprocessor_1.When)(`j'entre la valeur {string} dans le tableau nommée {string}`, function (textToType, name) {
+(0, cypress_cucumber_preprocessor_1.When)(`j'entre la valeur {string} dans le tableau nommé {string}`, function (textToType, name) {
     cy.uuvFindByRole("table", { name: name }).uuvFoundedElement().type(textToType);
 });
 // End of Type Section
@@ -56,19 +56,19 @@ const core_engine_1 = require("../../../core-engine");
 /**
  * Vérifie l'existence d'un élément Html ayant le rôle table, le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) et le contenu spécifiés
  * */
-(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir une tableau nommée {string} et contenant {string}`, function (name, expectedTextContent) {
+(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir un tableau nommé {string} et contenant {string}`, function (name, expectedTextContent) {
     (0, core_engine_1.findWithRoleAndNameAndContent)("table", name, expectedTextContent);
 });
 /**
  * Vérifie l'existence d'un élément Html ayant le rôle table, le [nom accessible](https://russmaxdesign.github.io/html-elements-names/), le contenu spécifiés et avec l'attribut disabled à false
  * */
-(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir une tableau nommée {string} et contenant {string} inactif`, function (name, expectedTextContent) {
+(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir un tableau nommé {string} et contenant {string} inactif`, function (name, expectedTextContent) {
     (0, core_engine_1.findWithRoleAndNameAndContentDisable)("table", name, expectedTextContent);
 });
 /**
  * Vérifie l'existence d'un élément Html ayant le rôle table, le [nom accessible](https://russmaxdesign.github.io/html-elements-names/), le contenu spécifiés et avec l'attribut disabled à true
  * */
-(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir une tableau nommée {string} et contenant {string} actif`, function (name, expectedTextContent) {
+(0, cypress_cucumber_preprocessor_1.Then)(`je dois voir un tableau nommé {string} et contenant {string} actif`, function (name, expectedTextContent) {
     (0, core_engine_1.findWithRoleAndNameAndContentEnable)("table", name, expectedTextContent);
 });
 // End of Content Section

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/cypress",
-  "version": "2.57.0",
+  "version": "2.58.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A solution to facilitate the writing and execution of E2E tests understandable by any human being using cucumber(BDD) and cypress",
@@ -48,7 +48,7 @@
     "@cypress/webpack-preprocessor": "6.0.4",
     "@testing-library/cypress": "10.0.3",
     "@uuv/a11y": "1.0.0-beta.71",
-    "@uuv/runner-commons": "2.51.0",
+    "@uuv/runner-commons": "2.52.0",
     "axe-core": "4.10.3",
     "chai-subset": "^1.6.0",
     "cypress": "14.4.0",

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

@@ -32,7 +32,7 @@ import {
     withinRoleAndName
 } from "../core-engine";
 import { A11yReferenceEnum } from "@uuv/a11y";
-import { pressKey } from "./../_.common";
+import { expectTableToHaveContent, pressKey, removeHeaderSeparatorLine } from "./../_.common";
 
 /**
  * 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://
@@ -488,6 +488,38 @@ Then(
  }
 );
 
+/**
+ * Checks that there is a list with the specified [name](https://russmaxdesign.github.io/html-elements-names/) containing list items.<br/> <u>Example</u>\n```gherkin\nThen I should see a list named "test-list" and containing\n| First element   |\n| Second element  |\n| Third element   |\n```
+ * */
+Then(
+    `I should see a grid named {string} and containing`,
+    function(expectedListName: string, pExpectedElementsOfList: DataTable) {
+        const expectedElementsOfList = removeHeaderSeparatorLine(pExpectedElementsOfList);
+        cy.uuvFindByRole("grid", { name: expectedListName })
+            .uuvFoundedElement()
+            .should("exist")
+            .within(() => {
+                expectTableToHaveContent(expectedElementsOfList, "gridcell");
+            });
+    }
+);
+
+/**
+ * Checks that there is a table with the specified [name](https://russmaxdesign.github.io/html-elements-names/) containing list items.<br/> <u>Example</u>\n```gherkin\nThen I should see a list named "test-list" and containing\n| First element   |\n| Second element  |\n| Third element   |\n```
+ * */
+Then(
+    `I should see a table named {string} and containing`,
+    function(expectedListName: string, pExpectedElementsOfList: DataTable) {
+        const expectedElementsOfList = removeHeaderSeparatorLine(pExpectedElementsOfList);
+        cy.uuvFindByRole("table", { name: expectedListName })
+            .uuvFoundedElement()
+            .should("exist")
+            .within(() => {
+                expectTableToHaveContent(expectedElementsOfList, "cell");
+            });
+    }
+);
+
 /**
  * Checks Html attributes of the selected element
  * */

package/src/cucumber/step_definitions/cypress/generated/_fr-generated-cucumber-steps-definition.ts

@@ -32,7 +32,7 @@ import {
     withinRoleAndName
 } from "../core-engine";
 import { A11yReferenceEnum } from "@uuv/a11y";
-import { pressKey } from "./../_.common";
+import { expectTableToHaveContent, pressKey, removeHeaderSeparatorLine } from "./../_.common";
 
 /**
  * Navigue vers l'Uri passé en paramètre (url complète étant constituée de la BASE_URL + Uri) ou navigue vers l'Url si ça commence par http:// ou https://
@@ -488,6 +488,38 @@ Then(
  }
 );
 
+/**
+ * Vérifie qu'il existe une liste avec le nom et les éléments de liste spécifiés.<br/> <u>Exemple</u>\n```gherkin\nAlors je dois voir une liste nommée "test-list" et contenant\n| Premier élément   |\n| Deuxième élément  |\n| Troisième élément   |\n```
+ * */
+Then(
+    `je dois voir une grille nommée {string} et contenant`,
+    function(expectedListName: string, pExpectedElementsOfList: DataTable) {
+        const expectedElementsOfList = removeHeaderSeparatorLine(pExpectedElementsOfList);
+        cy.uuvFindByRole("grid", { name: expectedListName })
+            .uuvFoundedElement()
+            .should("exist")
+            .within(() => {
+                expectTableToHaveContent(expectedElementsOfList, "gridcell");
+            });
+    }
+);
+
+/**
+ * Vérifie qu'il existe une liste avec le nom et les éléments de liste spécifiés.<br/> <u>Exemple</u>\n```gherkin\nAlors je dois voir une liste nommée "test-list" et contenant\n| Premier élément   |\n| Deuxième élément  |\n| Troisième élément   |\n```
+ * */
+Then(
+    `je dois voir un tableau nommé {string} et contenant`,
+    function(expectedListName: string, pExpectedElementsOfList: DataTable) {
+        const expectedElementsOfList = removeHeaderSeparatorLine(pExpectedElementsOfList);
+        cy.uuvFindByRole("table", { name: expectedListName })
+            .uuvFoundedElement()
+            .should("exist")
+            .within(() => {
+                expectTableToHaveContent(expectedElementsOfList, "cell");
+            });
+    }
+);
+
 /**
  * Vérifie des attributs Html de l'élément sélectionné
  * */

package/src/cucumber/step_definitions/cypress/generated/enriched/fr/_fr-generated-steps-definition_table.ts

@@ -36,14 +36,14 @@ import { pressKey } from "../../../_.common";
 /**
  * Sélectionne l'élément ayant le rôle table et le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) sont spécifiés <br />⚠ pensez à déselectionner l'élement avec <b>[je reinitialise le contexte](#je-reinitialise-le-contexte)</b> si vous n'agissez plus dessus
  * */
-When(`je vais à l'intérieur de la tableau nommée {string}`, function(name: string) {
+When(`je vais à l'intérieur du tableau nommé {string}`, function(name: string) {
     withinRoleAndName("table", name);
 });
 
 /**
  * Vérifie l'existence d'un élément Html ayant le rôle table et le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) spécifiés
  * */
-Then(`je dois voir une tableau nommée {string}`, function(name: string) {
+Then(`je dois voir un tableau nommé {string}`, function(name: string) {
     findWithRoleAndName("table", name);
 });
 
@@ -51,7 +51,7 @@ Then(`je dois voir une tableau nommée {string}`, function(name: string) {
  * Vérifie l'inexistence d'un élément Html ayant le rôle table et le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) spécifiés
  * */
 Then(
-    `je ne dois pas voir une tableau nommée {string}`,
+    `je ne dois pas voir un tableau nommé {string}`,
     function(name: string) {
         notFoundWithRoleAndName("table", name);
     }
@@ -64,14 +64,14 @@ Then(
 /**
  * Saisie de la phrase passée en paramètre dans le champ spécifié (utile par exemple pour remplir un champ de formulaire).
  * */
-When(`je saisie le(s) mot(s) {string} dans le tableau nommée {string}`, function(textToType: string, name: string) {
+When(`je saisie le(s) mot(s) {string} dans le tableau nommé {string}`, function(textToType: string, name: string) {
     cy.uuvFindByRole("table", { name: name }).uuvFoundedElement().type(textToType);
 });
 
 /**
  * Saisie de la phrase passée en paramètre dans le champ spécifié (utile par exemple pour remplir un champ de formulaire).
  * */
-When(`j'entre la valeur {string} dans le tableau nommée {string}`, function(textToType: string, name: string) {
+When(`j'entre la valeur {string} dans le tableau nommé {string}`, function(textToType: string, name: string) {
     cy.uuvFindByRole("table", { name: name }).uuvFoundedElement().type(textToType);
 });
 
@@ -82,7 +82,7 @@ When(`j'entre la valeur {string} dans le tableau nommée {string}`, function(tex
  * Vérifie l'existence d'un élément Html ayant le rôle table, le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) et le contenu spécifiés
  * */
 Then(
-    `je dois voir une tableau nommée {string} et contenant {string}`,
+    `je dois voir un tableau nommé {string} et contenant {string}`,
     function(name: string, expectedTextContent: string) {
         findWithRoleAndNameAndContent("table", name, expectedTextContent);
     }
@@ -92,7 +92,7 @@ Then(
  * Vérifie l'existence d'un élément Html ayant le rôle table, le [nom accessible](https://russmaxdesign.github.io/html-elements-names/), le contenu spécifiés et avec l'attribut disabled à false
  * */
 Then(
-    `je dois voir une tableau nommée {string} et contenant {string} inactif`,
+    `je dois voir un tableau nommé {string} et contenant {string} inactif`,
     function(name: string, expectedTextContent: string) {
         findWithRoleAndNameAndContentDisable("table", name, expectedTextContent);
     }
@@ -102,7 +102,7 @@ Then(
  * Vérifie l'existence d'un élément Html ayant le rôle table, le [nom accessible](https://russmaxdesign.github.io/html-elements-names/), le contenu spécifiés et avec l'attribut disabled à true
  * */
 Then(
-    `je dois voir une tableau nommée {string} et contenant {string} actif`,
+    `je dois voir un tableau nommé {string} et contenant {string} actif`,
     function(name: string, expectedTextContent: string) {
         findWithRoleAndNameAndContentEnable("table", name, expectedTextContent);
     }