@uuv/runner-commons 2.21.0 → 2.22.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# [2.22.0](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.21.0...runner-commons-v2.22.0) (2024-08-05)
+
+
+### Bug Fixes
+
+* **runner-cypress:** update dependency cypress to v13.13.2 ([7b0044e](https://github.com/Orange-OpenSource/uuv/commit/7b0044efdf2448c6883029e9cefcae05927d5264))
+
+
+### Features
+
+* add checked state sentences, [#733](https://github.com/Orange-OpenSource/uuv/issues/733) ([62abd39](https://github.com/Orange-OpenSource/uuv/commit/62abd394259574965d543fc5e40c3854f3dbaf1d))
+* **assistant:** update dependency antd to v5.20.0 ([709fdd3](https://github.com/Orange-OpenSource/uuv/commit/709fdd3b222b2b9ff4a6fcc0649e704ad81327b1))
+
 # [2.21.0](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.20.0...runner-commons-v2.21.0) (2024-07-28)
 
 

package/dist/assets/i18n/web/en/en-enriched-wordings.json

@@ -59,6 +59,18 @@
             "description": "Writes the sentence given as a parameter inside the specified field (useful for example to fill in a form field)",
             "wording": "I type the sentence {string} in $definiteArticle $roleName named {string}",
             "section": "type"
+        },
+        {
+            "key": "key.then.element.withRoleAndNameAndChecked",
+            "description": "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/) and is checked",
+            "wording": "I should see $indefiniteArticle $roleName named {string} checked",
+            "section": "checkable"
+        },
+        {
+            "key": "key.then.element.withRoleAndNameAndUnchecked",
+            "description": "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/) and is unchecked",
+            "wording": "I should see $indefiniteArticle $roleName named {string} unchecked",
+            "section": "checkable"
         }
     ]
 }

package/dist/assets/i18n/web/en/en-roles.js

@@ -19,7 +19,8 @@ class EnAccessibleRole extends accessible_role_1.AccessibleRole {
     shouldGenerateTypeSentence;
     shouldGenerateContainsSentence;
     shouldGenerateKeyboardSentence;
-    constructor(id, name, definiteArticle = DEFINITE_ARTICLE.THE, indefiniteArticle = INDEFINITE_ARTICLE.A, shouldGenerateTypeSentence = true, shouldGenerateContainsSentence = true, shouldGenerateKeyboardSentence = false) {
+    shouldGenerateCheckedSentence;
+    constructor(id, name, definiteArticle = DEFINITE_ARTICLE.THE, indefiniteArticle = INDEFINITE_ARTICLE.A, shouldGenerateTypeSentence = true, shouldGenerateContainsSentence = true, shouldGenerateKeyboardSentence = false, shouldGenerateCheckedSentence = false) {
         super();
         this.id = id;
         this.name = name;
@@ -28,9 +29,10 @@ class EnAccessibleRole extends accessible_role_1.AccessibleRole {
         this.shouldGenerateTypeSentence = shouldGenerateTypeSentence;
         this.shouldGenerateContainsSentence = shouldGenerateContainsSentence;
         this.shouldGenerateKeyboardSentence = shouldGenerateKeyboardSentence;
+        this.shouldGenerateCheckedSentence = shouldGenerateCheckedSentence;
     }
     static from(input) {
-        return new EnAccessibleRole(input.id, input.name, input.definiteArticle, input.indefiniteArticle, input.shouldGenerateTypeSentence, input.shouldGenerateContainsSentence, input.shouldGenerateKeyboardSentence);
+        return new EnAccessibleRole(input.id, input.name, input.definiteArticle, input.indefiniteArticle, input.shouldGenerateTypeSentence, input.shouldGenerateContainsSentence, input.shouldGenerateKeyboardSentence, input.shouldGenerateCheckedSentence);
     }
     getDefiniteArticle() {
         return this.definiteArticle.toString();
@@ -53,7 +55,7 @@ exports.EN_ROLES = [
     { id: "banner", name: "banner" },
     { id: "button", name: "button", shouldGenerateKeyboardSentence: true },
     { id: "cell", name: "cell" },
-    { id: "checkbox", name: "checkbox", shouldGenerateKeyboardSentence: true },
+    { id: "checkbox", name: "checkbox", shouldGenerateKeyboardSentence: true, shouldGenerateCheckedSentence: true },
     { id: "columnheader", name: "column header" },
     { id: "combobox", name: "combo box", shouldGenerateKeyboardSentence: true },
     { id: "command", name: "command" },
@@ -87,7 +89,7 @@ exports.EN_ROLES = [
     { id: "menubar", name: "menubar" },
     { id: "menuitem", name: "menuitem", shouldGenerateKeyboardSentence: true },
     { id: "menuitemcheckbox", name: "menuitemcheckbox", shouldGenerateKeyboardSentence: true },
-    { id: "menuitemradio", name: "menuitemradio", shouldGenerateKeyboardSentence: true },
+    { id: "menuitemradio", name: "menuitemradio", shouldGenerateKeyboardSentence: true, shouldGenerateCheckedSentence: true },
     { id: "meter", name: "counter" },
     { id: "navigation", name: "navigation" },
     { id: "none", name: "no" },
@@ -95,7 +97,7 @@ exports.EN_ROLES = [
     { id: "option", name: "option", indefiniteArticle: INDEFINITE_ARTICLE.AN },
     { id: "presentation", name: "presentation" },
     { id: "progressbar", name: "progress bar" },
-    { id: "radio", name: "radio", shouldGenerateKeyboardSentence: true },
+    { id: "radio", name: "radio", shouldGenerateKeyboardSentence: true, shouldGenerateCheckedSentence: true },
     { id: "radiogroup", name: "radio group" },
     { id: "range", name: "range" },
     { id: "region", name: "region" },

package/dist/assets/i18n/web/fr/fr-roles.js

@@ -21,7 +21,8 @@ class FrAccessibleRole extends accessible_role_1.AccessibleRole {
     shouldGenerateTypeSentence;
     shouldGenerateContainsSentence;
     shouldGenerateKeyboardSentence;
-    constructor(id, name, definiteArticle, indefiniteArticle, shouldGenerateTypeSentence = true, shouldGenerateContainsSentence = true, shouldGenerateKeyboardSentence = false) {
+    shouldGenerateCheckedSentence;
+    constructor(id, name, definiteArticle, indefiniteArticle, shouldGenerateTypeSentence = true, shouldGenerateContainsSentence = true, shouldGenerateKeyboardSentence = false, shouldGenerateCheckedSentence = false) {
         super();
         this.id = id;
         this.name = name;
@@ -30,6 +31,7 @@ class FrAccessibleRole extends accessible_role_1.AccessibleRole {
         this.shouldGenerateTypeSentence = shouldGenerateTypeSentence;
         this.shouldGenerateContainsSentence = shouldGenerateContainsSentence;
         this.shouldGenerateKeyboardSentence = shouldGenerateKeyboardSentence;
+        this.shouldGenerateCheckedSentence = shouldGenerateCheckedSentence;
     }
     getDefiniteArticle() {
         return this.definiteArticle.toString();
@@ -103,7 +105,8 @@ exports.FR_ROLES = [
         name: "case à cocher",
         definiteArticle: FR_DEFINITE_ARTICLE.LA,
         indefiniteArticle: FR_INDEFINITE_ARTICLE.UNE,
-        shouldGenerateKeyboardSentence: true
+        shouldGenerateKeyboardSentence: true,
+        shouldGenerateCheckedSentence: true
     },
     {
         id: "columnheader",
@@ -315,7 +318,8 @@ exports.FR_ROLES = [
         name: "menu d'élement de bouton radio",
         definiteArticle: FR_DEFINITE_ARTICLE.LE,
         indefiniteArticle: FR_INDEFINITE_ARTICLE.UN,
-        shouldGenerateKeyboardSentence: true
+        shouldGenerateKeyboardSentence: true,
+        shouldGenerateCheckedSentence: true
     },
     {
         id: "meter",
@@ -364,7 +368,8 @@ exports.FR_ROLES = [
         name: "bouton radio",
         definiteArticle: FR_DEFINITE_ARTICLE.LE,
         indefiniteArticle: FR_INDEFINITE_ARTICLE.UN,
-        shouldGenerateKeyboardSentence: true
+        shouldGenerateKeyboardSentence: true,
+        shouldGenerateCheckedSentence: true
     },
     {
         id: "radiogroup",
@@ -579,4 +584,4 @@ exports.FR_ROLES = [
         definiteArticle: FR_DEFINITE_ARTICLE.LA,
         indefiniteArticle: FR_INDEFINITE_ARTICLE.UNE
     }
-].map((role) => new FrAccessibleRole(role.id, role.name, role.definiteArticle, role.indefiniteArticle, role.shouldGenerateContainsSentence, role.shouldGenerateContainsSentence, role.shouldGenerateKeyboardSentence));
+].map((role) => new FrAccessibleRole(role.id, role.name, role.definiteArticle, role.indefiniteArticle, role.shouldGenerateContainsSentence, role.shouldGenerateContainsSentence, role.shouldGenerateKeyboardSentence, role.shouldGenerateCheckedSentence));

package/dist/assets/i18n/web/template.json

@@ -46,6 +46,8 @@
             "withRoleAndName": "",
             "withTestId": "",
             "withRoleAndNameAndContent": "",
+            "withRoleAndNameAndChecked": "",
+            "withRoleAndNameAndUnchecked": "",
             "withRoleAndNameFocused": "",
             "nextWithRoleAndNameFocused": "",
             "previousWithRoleAndNameFocused": "",

package/dist/step-definition-generator/accessible-role.d.ts

@@ -4,6 +4,7 @@ export declare abstract class AccessibleRole {
     shouldGenerateTypeSentence: boolean;
     shouldGenerateContainsSentence: boolean;
     shouldGenerateKeyboardSentence: boolean;
+    shouldGenerateCheckedSentence: boolean;
     abstract getDefiniteArticle(): string;
     abstract getIndefiniteArticle(): string;
     abstract getOfDefiniteArticle(): string;

package/dist/step-definition-generator/accessible-role.js

@@ -7,5 +7,6 @@ class AccessibleRole {
     shouldGenerateTypeSentence;
     shouldGenerateContainsSentence;
     shouldGenerateKeyboardSentence = false;
+    shouldGenerateCheckedSentence = false;
 }
 exports.AccessibleRole = AccessibleRole;

package/dist/step-definition-generator/generate-based-role-step-definitions.js

@@ -103,6 +103,10 @@ class BasedRoleStepDefinition extends common_1.GenerateFileProcessing {
             if (!role.shouldGenerateKeyboardSentence) {
                 dataUpdated = dataUpdated.replace(/\/\/ Begin of Keyboard Section[\s\S]*?\/\/ End of Keyboard Section/, "");
             }
+            // Exclude Role based Checked sentence if specified
+            if (!role.shouldGenerateCheckedSentence) {
+                dataUpdated = dataUpdated.replace(/\/\/ Begin of Checkable Section[\s\S]*?\/\/ End of Checkable Section/, "");
+            }
             const generatedFilename = generatedFile.replace("$roleId", role.id);
             // console.debug(">>> data", dataUpdated)
             // console.debug(">>> generatedFilename", generatedFilename)

package/dist/step-definition-generator/generate-step-definitions-documentation.js

@@ -202,6 +202,8 @@ function runGenerateDoc(destDir) {
                 return role.shouldGenerateTypeSentence;
             case "keyboard":
                 return role.shouldGenerateKeyboardSentence;
+            case "checkable":
+                return role.shouldGenerateCheckedSentence;
             default:
                 return true;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/runner-commons",
-  "version": "2.21.0",
+  "version": "2.22.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A common lib for uuv",

package/src/assets/i18n/web/en/en-enriched-wordings.json

@@ -59,6 +59,18 @@
       "description": "Writes the sentence given as a parameter inside the specified field (useful for example to fill in a form field)",
       "wording": "I type the sentence {string} in $definiteArticle $roleName named {string}",
       "section": "type"
+    },
+    {
+      "key": "key.then.element.withRoleAndNameAndChecked",
+      "description": "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/) and is checked",
+      "wording": "I should see $indefiniteArticle $roleName named {string} checked",
+      "section": "checkable"
+    },
+    {
+      "key": "key.then.element.withRoleAndNameAndUnchecked",
+      "description": "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/) and is unchecked",
+      "wording": "I should see $indefiniteArticle $roleName named {string} unchecked",
+      "section": "checkable"
     }
   ]
 }

package/src/assets/i18n/web/fr/fr-enriched-wordings.json

@@ -59,6 +59,18 @@
       "description": "Saisie de la phrase passée en paramètre dans le champ spécifié(utile par exemple pour remplir un champ de formulaire).",
       "wording": "je saisie le(s) mot(s) {string} dans $definiteArticle$roleName $namedAdjective {string}",
       "section": "type"
+    },
+    {
+      "key": "key.then.element.withRoleAndNameAndChecked",
+      "description": "Vérifie l'existence d'un élément Html ayant le rôle $roleId, le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) et coché",
+      "wording": "je dois voir $indefiniteArticle $roleName $namedAdjective {string} coché(e)",
+      "section": "checkable"
+    },
+    {
+      "key": "key.then.element.withRoleAndNameAndUnchecked",
+      "description": "Vérifie l'existence d'un élément Html ayant le rôle $roleId, le [nom accessible](https://russmaxdesign.github.io/html-elements-names/) et décoché",
+      "wording": "je dois voir $indefiniteArticle $roleName $namedAdjective {string} décoché(e)",
+      "section": "checkable"
     }
   ]
 }