@uuv/runner-commons 2.24.0 → 2.25.0

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+# [2.25.0](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.24.1...runner-commons-v2.25.0) (2024-09-01)
+
+
+### Bug Fixes
+
+* set focus after within action ([e671f2c](https://github.com/Orange-OpenSource/uuv/commit/e671f2c378e21c90b7f1a57cc4f9ab7481c59283))
+
+
+### Features
+
+* add enter sentence, [#732](https://github.com/Orange-OpenSource/uuv/issues/732) ([ac4ea9e](https://github.com/Orange-OpenSource/uuv/commit/ac4ea9e1fdf27a0c17827f54e12b3f487db66e4d))
+* **assistant:** add form completion, [#719](https://github.com/Orange-OpenSource/uuv/issues/719) ([ea74b23](https://github.com/Orange-OpenSource/uuv/commit/ea74b239c37c1b30b155400d6f2f30a939975d3e))
+* change type and click sentence to basedRole sentence, [#731](https://github.com/Orange-OpenSource/uuv/issues/731) ([3131e3d](https://github.com/Orange-OpenSource/uuv/commit/3131e3d5eecbf6b04a06ba70b20ebe041690747c))
+
+## [2.24.1](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.24.0...runner-commons-v2.24.1) (2024-08-25)
+
+
+### Bug Fixes
+
+* **runner-cypress:** update dependency cypress to v13.13.3 ([c536497](https://github.com/Orange-OpenSource/uuv/commit/c536497539eeead0b8b14bf5901ac0622e6339c1))
+* **runner-playwright:** update dependency axe-playwright to v2.0.2 ([f745bff](https://github.com/Orange-OpenSource/uuv/commit/f745bffabe494a88962d7d38e7b7450c9f324d52))
+
 # [2.24.0](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.23.0...runner-commons-v2.24.0) (2024-08-18)
 
 

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

@@ -71,6 +71,18 @@
             "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"
+        },
+        {
+            "key": "key.when.enter",
+            "description": "Writes the sentence given as a parameter inside the specified field (useful for example to fill in a form field)",
+            "wording": "I enter the value {string} in $definiteArticle $roleName named {string}",
+            "section": "type"
+        },
+        {
+            "key": "key.when.click",
+            "description": "Triggers a click on the element with role $roleId and the specified name",
+            "wording": "I click on $roleName named {string}",
+            "section": "click"
         }
     ]
 }

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

@@ -16,23 +16,25 @@ class EnAccessibleRole extends accessible_role_1.AccessibleRole {
     name;
     definiteArticle;
     indefiniteArticle;
+    shouldGenerateClickSentence;
     shouldGenerateTypeSentence;
     shouldGenerateContainsSentence;
     shouldGenerateKeyboardSentence;
     shouldGenerateCheckedSentence;
-    constructor(id, name, definiteArticle = DEFINITE_ARTICLE.THE, indefiniteArticle = INDEFINITE_ARTICLE.A, shouldGenerateTypeSentence = true, shouldGenerateContainsSentence = true, shouldGenerateKeyboardSentence = false, shouldGenerateCheckedSentence = false) {
+    constructor(id, name, definiteArticle = DEFINITE_ARTICLE.THE, indefiniteArticle = INDEFINITE_ARTICLE.A, shouldGenerateClickSentence = false, shouldGenerateTypeSentence = true, shouldGenerateContainsSentence = true, shouldGenerateKeyboardSentence = false, shouldGenerateCheckedSentence = false) {
         super();
         this.id = id;
         this.name = name;
         this.definiteArticle = definiteArticle;
         this.indefiniteArticle = indefiniteArticle;
+        this.shouldGenerateClickSentence = shouldGenerateClickSentence;
         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, input.shouldGenerateCheckedSentence);
+        return new EnAccessibleRole(input.id, input.name, input.definiteArticle, input.indefiniteArticle, input.shouldGenerateClickSentence, input.shouldGenerateTypeSentence, input.shouldGenerateContainsSentence, input.shouldGenerateKeyboardSentence, input.shouldGenerateCheckedSentence);
     }
     getDefiniteArticle() {
         return this.definiteArticle.toString();
@@ -53,9 +55,9 @@ exports.EN_ROLES = [
     { id: "application", name: "application", indefiniteArticle: INDEFINITE_ARTICLE.AN },
     { id: "article", name: "article", indefiniteArticle: INDEFINITE_ARTICLE.AN },
     { id: "banner", name: "banner" },
-    { id: "button", name: "button", shouldGenerateKeyboardSentence: true },
+    { id: "button", name: "button", shouldGenerateKeyboardSentence: true, shouldGenerateClickSentence: true },
     { id: "cell", name: "cell" },
-    { id: "checkbox", name: "checkbox", shouldGenerateKeyboardSentence: true, shouldGenerateCheckedSentence: true },
+    { id: "checkbox", name: "checkbox", shouldGenerateKeyboardSentence: true, shouldGenerateCheckedSentence: true, shouldGenerateClickSentence: true },
     { id: "columnheader", name: "column header" },
     { id: "combobox", name: "combo box", shouldGenerateKeyboardSentence: true },
     { id: "command", name: "command" },
@@ -77,7 +79,7 @@ exports.EN_ROLES = [
     { id: "heading", name: "title" },
     { id: "img", name: "picture" },
     { id: "landmark", name: "landmark" },
-    { id: "link", name: "link", shouldGenerateKeyboardSentence: true },
+    { id: "link", name: "link", shouldGenerateKeyboardSentence: true, shouldGenerateClickSentence: true },
     { id: "list", name: "list", shouldGenerateContainsSentence: false, shouldGenerateTypeSentence: false },
     { id: "listbox", name: "list box", shouldGenerateKeyboardSentence: true },
     { id: "listitem", name: "list item" },
@@ -87,7 +89,7 @@ exports.EN_ROLES = [
     { id: "math", name: "math" },
     { id: "menu", name: "menu" },
     { id: "menubar", name: "menubar" },
-    { id: "menuitem", name: "menuitem", shouldGenerateKeyboardSentence: true },
+    { id: "menuitem", name: "menuitem", shouldGenerateKeyboardSentence: true, shouldGenerateClickSentence: true },
     { id: "menuitemcheckbox", name: "menuitemcheckbox", shouldGenerateKeyboardSentence: true },
     { id: "menuitemradio", name: "menuitemradio", shouldGenerateKeyboardSentence: true, shouldGenerateCheckedSentence: true },
     { id: "meter", name: "counter" },
@@ -97,7 +99,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, shouldGenerateCheckedSentence: true },
+    { id: "radio", name: "radio", shouldGenerateKeyboardSentence: true, shouldGenerateCheckedSentence: true, shouldGenerateClickSentence: true },
     { id: "radiogroup", name: "radio group" },
     { id: "range", name: "range" },
     { id: "region", name: "region" },

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

@@ -4,16 +4,6 @@
         "description": "Triggers a click on the selected element.<br/>Make sure you've selected an element beforehand with the <strong>within...</strong> phrases.",
         "wording": "I click"
     },
-    {
-        "key": "key.when.click.button",
-        "description": "Triggers a click on the given button with specific name",
-        "wording": "I click on button named {string}"
-    },
-    {
-        "key": "key.when.click.link",
-        "description": "Triggers a click on the given link with specific name",
-        "wording": "I click on link named {string}"
-    },
     {
         "key": "key.when.click.withRole",
         "description": "Triggers a click on the element with given role and specific name",
@@ -40,10 +30,15 @@
         "wording": "I set timeout with value {int}"
     },
     {
-        "key": "key.when.type",
+        "key": "key.when.type.withContext",
         "description": "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.",
         "wording": "I type the sentence {string}"
     },
+    {
+        "key": "key.when.enter.withContext",
+        "description": "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.",
+        "wording": "I enter the value {string}"
+    },
     {
         "key": "key.when.keyboard.press",
         "description": "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.",

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

@@ -18,16 +18,18 @@ class FrAccessibleRole extends accessible_role_1.AccessibleRole {
     name;
     definiteArticle;
     indefiniteArticle;
+    shouldGenerateClickSentence;
     shouldGenerateTypeSentence;
     shouldGenerateContainsSentence;
     shouldGenerateKeyboardSentence;
     shouldGenerateCheckedSentence;
-    constructor(id, name, definiteArticle, indefiniteArticle, shouldGenerateTypeSentence = true, shouldGenerateContainsSentence = true, shouldGenerateKeyboardSentence = false, shouldGenerateCheckedSentence = false) {
+    constructor(id, name, definiteArticle, indefiniteArticle, shouldGenerateClickSentence = false, shouldGenerateTypeSentence = true, shouldGenerateContainsSentence = true, shouldGenerateKeyboardSentence = false, shouldGenerateCheckedSentence = false) {
         super();
         this.id = id;
         this.name = name;
         this.definiteArticle = definiteArticle;
         this.indefiniteArticle = indefiniteArticle;
+        this.shouldGenerateClickSentence = shouldGenerateClickSentence;
         this.shouldGenerateTypeSentence = shouldGenerateTypeSentence;
         this.shouldGenerateContainsSentence = shouldGenerateContainsSentence;
         this.shouldGenerateKeyboardSentence = shouldGenerateKeyboardSentence;
@@ -92,6 +94,7 @@ exports.FR_ROLES = [
         name: "bouton",
         definiteArticle: FR_DEFINITE_ARTICLE.LE,
         indefiniteArticle: FR_INDEFINITE_ARTICLE.UN,
+        shouldGenerateClickSentence: true,
         shouldGenerateKeyboardSentence: true
     },
     {
@@ -105,6 +108,7 @@ exports.FR_ROLES = [
         name: "case à cocher",
         definiteArticle: FR_DEFINITE_ARTICLE.LA,
         indefiniteArticle: FR_INDEFINITE_ARTICLE.UNE,
+        shouldGenerateClickSentence: true,
         shouldGenerateKeyboardSentence: true,
         shouldGenerateCheckedSentence: true
     },
@@ -240,6 +244,7 @@ exports.FR_ROLES = [
         name: "lien",
         definiteArticle: FR_DEFINITE_ARTICLE.LE,
         indefiniteArticle: FR_INDEFINITE_ARTICLE.UN,
+        shouldGenerateClickSentence: true,
         shouldGenerateKeyboardSentence: true
     },
     {
@@ -368,6 +373,7 @@ exports.FR_ROLES = [
         name: "bouton radio",
         definiteArticle: FR_DEFINITE_ARTICLE.LE,
         indefiniteArticle: FR_INDEFINITE_ARTICLE.UN,
+        shouldGenerateClickSentence: true,
         shouldGenerateKeyboardSentence: true,
         shouldGenerateCheckedSentence: true
     },
@@ -584,4 +590,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, role.shouldGenerateCheckedSentence));
+].map((role) => new FrAccessibleRole(role.id, role.name, role.definiteArticle, role.indefiniteArticle, role.shouldGenerateClickSentence, role.shouldGenerateContainsSentence, role.shouldGenerateContainsSentence, role.shouldGenerateKeyboardSentence, role.shouldGenerateCheckedSentence));

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

@@ -6,7 +6,12 @@
             "withRole": "",
             "withContext": ""
         },
-        "type": "",
+        "type": {
+            "withContext": ""
+        },
+        "enter": {
+            "withContext": ""
+        },
         "keyboard": {
             "multiplePress": "",
             "press": "",

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

@@ -1,6 +1,7 @@
 export declare abstract class AccessibleRole {
     id: string;
     name: string;
+    shouldGenerateClickSentence: boolean;
     shouldGenerateTypeSentence: boolean;
     shouldGenerateContainsSentence: boolean;
     shouldGenerateKeyboardSentence: boolean;

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

@@ -4,6 +4,7 @@ exports.AccessibleRole = void 0;
 class AccessibleRole {
     id;
     name;
+    shouldGenerateClickSentence;
     shouldGenerateTypeSentence;
     shouldGenerateContainsSentence;
     shouldGenerateKeyboardSentence = false;

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

@@ -96,6 +96,10 @@ class BasedRoleStepDefinition extends common_1.GenerateFileProcessing {
                 dataUpdated = dataUpdated.replace(/\/\/ Begin of Content Section[\s\S]*?\/\/ End of Content Section/, "");
             }
             // Exclude Role based Type sentence if specified
+            if (!role.shouldGenerateClickSentence) {
+                dataUpdated = dataUpdated.replace(/\/\/ Begin of Click Section[\s\S]*?\/\/ End of Click Section/, "");
+            }
+            // Exclude Role based Type sentence if specified
             if (!role.shouldGenerateTypeSentence) {
                 dataUpdated = dataUpdated.replace(/\/\/ Begin of Type Section[\s\S]*?\/\/ End of Type Section/, "");
             }

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

@@ -198,6 +198,8 @@ function runGenerateDoc(destDir) {
         switch (wordingsConf.section) {
             case "contains":
                 return role.shouldGenerateContainsSentence;
+            case "click":
+                return role.shouldGenerateClickSentence;
             case "type":
                 return role.shouldGenerateTypeSentence;
             case "keyboard":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/runner-commons",
-  "version": "2.24.0",
+  "version": "2.25.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

@@ -71,6 +71,18 @@
       "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"
+    },
+    {
+      "key": "key.when.enter",
+      "description": "Writes the sentence given as a parameter inside the specified field (useful for example to fill in a form field)",
+      "wording": "I enter the value {string} in $definiteArticle $roleName named {string}",
+      "section": "type"
+    },
+    {
+     "key": "key.when.click",
+     "description": "Triggers a click on the element with role $roleId and the specified name",
+     "wording": "I click on $roleName named {string}",
+      "section": "click"
     }
   ]
 }

package/src/assets/i18n/web/en/en.json

@@ -4,16 +4,6 @@
   "description": "Triggers a click on the selected element.<br/>Make sure you've selected an element beforehand with the <strong>within...</strong> phrases.",
   "wording": "I click"
  },
- {
-  "key": "key.when.click.button",
-  "description": "Triggers a click on the given button with specific name",
-  "wording": "I click on button named {string}"
- },
- {
-  "key": "key.when.click.link",
-  "description": "Triggers a click on the given link with specific name",
-  "wording": "I click on link named {string}"
- },
  {
   "key": "key.when.click.withRole",
   "description": "Triggers a click on the element with given role and specific name",
@@ -40,10 +30,15 @@
   "wording": "I set timeout with value {int}"
  },
  {
-  "key": "key.when.type",
+  "key": "key.when.type.withContext",
   "description": "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.",
   "wording": "I type the sentence {string}"
  },
+ {
+  "key": "key.when.enter.withContext",
+  "description": "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.",
+  "wording": "I enter the value {string}"
+ },
  {
   "key": "key.when.keyboard.press",
   "description": "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.",

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

@@ -56,7 +56,7 @@
     },
     {
       "key": "key.when.type",
-      "description": "Saisie de la phrase passée en paramètre dans le champ spécifié(utile par exemple pour remplir un champ de formulaire).",
+      "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"
     },
@@ -71,6 +71,18 @@
       "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"
+    },
+    {
+      "key": "key.when.enter",
+      "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": "j'entre la valeur {string} dans $definiteArticle$roleName $namedAdjective {string}",
+      "section": "type"
+    },
+    {
+      "key": "key.when.click",
+      "description": "Déclenche un click sur l'élément Html ayant le rôle $roleId, le [nom accessible](https://russmaxdesign.github.io/html-elements-names/)",
+      "wording": "je clique sur $definiteArticle$roleName nommé {string}",
+      "section": "click"
     }
   ]
 }

package/src/assets/i18n/web/fr/fr.json

@@ -4,16 +4,6 @@
     "description": "Déclenche un click sur l'élément sélectionné.<br/>Assurez vous d'avoir effectué une sélection d'élément avant avec les phrases <strong>Je vais à l'intérieur...</strong>.",
     "wording": "je clique"
   },
-  {
-    "key": "key.when.click.button",
-    "description": "Déclenche un click sur le bouton avec le nom donné",
-    "wording": "je clique sur le bouton nommé {string}"
-  },
-  {
-    "key": "key.when.click.link",
-    "description": "Déclenche un click sur le lien avec le nom donné",
-    "wording": "je clique sur le lien nommé {string}"
-  },
   {
     "key": "key.when.click.withRole",
     "description": "Déclenche un click sur un élément avec le rôle et le nom donnés",
@@ -40,10 +30,15 @@
     "wording": "je positionne le timeout à {int} secondes"
   },
   {
-    "key": "key.when.type",
+    "key": "key.when.type.withContext",
     "description": "Saisit de la phrase passée en paramètre (utile par exemple pour remplir un champ de formulaire).<br/>Assurez vous d'avoir effectué une sélection d'élément avant avec les phrases <strong>Je vais à l'intérieur...</strong>.",
     "wording": "je saisie le(s) mot(s) {string}"
   },
+  {
+    "key": "key.when.enter.withContext",
+    "description": "Saisit de la phrase passée en paramètre (utile par exemple pour remplir un champ de formulaire).<br/>Assurez vous d'avoir effectué une sélection d'élément avant avec les phrases <strong>Je vais à l'intérieur...</strong>.",
+    "wording": "j'entre la valeur {string}"
+  },
   {
     "key": "key.when.keyboard.press",
     "description": "Simule un appui sur la touche spécifiée : <table><thead><tr><th>Touche</th><th>Description</th></tr></thead><tbody><tr><td>{tab}</td><td>Tabulation</td></tr><tr><td>{reverseTab}</td><td>Tabulation arrière</td></tr><tr><td>{down}</td><td>Flèche du bas</td></tr><tr><td>{right}</td><td>Flèche de droite</td></tr><tr><td>{left}</td><td>Flèche de gauche</td></tr><tr><td>{up}</td><td>Flèche du haut</td></tr></tbody></table>.<br/>Assurez vous d'avoir effectué une sélection d'élément avant avec les phrases <strong>Je vais à l'intérieur...</strong>.",