@uuv/runner-commons 1.10.6 → 1.12.0

package/dist/step-definition-generator/common.js

@@ -13,24 +13,64 @@
 * Software description: Make test writing fast, understandable by any human
 * understanding English or French.
 */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Common = exports.KEY_PRESS = exports.STEP_DEFINITION_FILE_NAME = exports.TEST_RUNNER_ENUM = exports.GenerateFileProcessing = exports.fs = void 0;
+exports.Common = exports.KEY_PRESS = exports.STEP_DEFINITION_FILE_NAME = exports.TEST_RUNNER_ENUM = exports.getDefinedRoles = exports.GenerateFileProcessing = exports.fs = void 0;
 const fs_1 = __importDefault(require("fs"));
 exports.fs = fs_1.default;
+const path = __importStar(require("path"));
+const lang_enum_1 = require("./lang-enum");
+const en_roles_1 = require("../assets/i18n/web/en/en-roles");
+const fr_roles_1 = require("../assets/i18n/web/fr/fr-roles");
 class GenerateFileProcessing {
     baseDir;
-    stepDefinitionFile = "";
-    generatedDir = "";
-    constructor(baseDir, runner, stepDefinitionFileName) {
+    stepDefinitionFile;
+    generatedDir;
+    wordingFilePath;
+    constructor(baseDir, runner, stepDefinitionFileName, wordingFileRelativePath) {
         this.baseDir = baseDir;
         this.stepDefinitionFile = `${this.baseDir}/src/cucumber/step_definitions/${runner.toString()}/${stepDefinitionFileName.toString()}.ts`;
         this.generatedDir = `${this.baseDir}/src/cucumber/step_definitions/${runner.toString()}/generated`;
+        this.stepDefinitionFile = path.join(this.baseDir, `src/cucumber/step_definitions/${runner.toString()}/${stepDefinitionFileName.toString()}.ts`);
+        this.generatedDir = path.join(this.baseDir, `src/cucumber/step_definitions/${runner.toString()}/generated`);
+        this.wordingFilePath = path.join(__dirname, `${wordingFileRelativePath}`);
     }
 }
 exports.GenerateFileProcessing = GenerateFileProcessing;
+function getDefinedRoles(lang) {
+    switch (lang) {
+        case lang_enum_1.LANG.FR.toString():
+            return fr_roles_1.FR_ROLES;
+        default:
+            return en_roles_1.EN_ROLES;
+    }
+}
+exports.getDefinedRoles = getDefinedRoles;
 var TEST_RUNNER_ENUM;
 (function (TEST_RUNNER_ENUM) {
     TEST_RUNNER_ENUM["CYPRESS"] = "cypress";

package/dist/step-definition-generator/generate-base-step-definitions.d.ts

@@ -1,7 +1,6 @@
-import { GenerateFileProcessing, STEP_DEFINITION_FILE_NAME, TEST_RUNNER_ENUM } from "./common";
+import { GenerateFileProcessing } from "./common";
 export declare class BaseStepDefinition extends GenerateFileProcessing {
-    constructor(baseDir: string, runner: TEST_RUNNER_ENUM, stepDefinitionFileName: STEP_DEFINITION_FILE_NAME);
     runGenerate(): void;
-    computeWordingFile(data: string, wordingFile: string): string;
     generateWordingFiles(generatedFile: string, lang: string): void;
+    computeWordingFile(data: string, wordingFile: string): string;
 }

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

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseStepDefinition = void 0;
 /**
@@ -15,19 +38,22 @@ exports.BaseStepDefinition = void 0;
  */
 const lang_enum_1 = require("./lang-enum");
 const common_1 = require("./common");
+const path = __importStar(require("path"));
 class BaseStepDefinition extends common_1.GenerateFileProcessing {
-    constructor(baseDir, runner, stepDefinitionFileName) {
-        super(baseDir, runner, stepDefinitionFileName);
-    }
     runGenerate() {
         Object.values(lang_enum_1.LANG).forEach((lang) => {
-            const generatedFile = `${this.generatedDir}/_${lang}-generated-cucumber-steps-definition.ts`;
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const generatedFile = path.join(this.generatedDir, `_${lang}-generated-cucumber-steps-definition.ts`);
             common_1.Common.buildDirIfNotExists(this.generatedDir);
             common_1.Common.cleanGeneratedFilesIfExists(generatedFile);
             this.generateWordingFiles(generatedFile, lang);
         });
     }
+    generateWordingFiles(generatedFile, lang) {
+        const wordingFile = path.join(this.wordingFilePath, lang, `${lang}.json`);
+        const data = common_1.fs.readFileSync(this.stepDefinitionFile, { encoding: "utf8" });
+        const updatedData = this.computeWordingFile(data, wordingFile);
+        common_1.Common.writeWordingFile(generatedFile, updatedData);
+    }
     computeWordingFile(data, wordingFile) {
         data =
             "/*******************************\n" +
@@ -41,8 +67,8 @@ class BaseStepDefinition extends common_1.GenerateFileProcessing {
             .replace("../../../cypress/commands", "../../../../cypress/commands")
             .replace("../../../playwright/chromium", "../../../../playwright/chromium")
             .replace("../i18n/template.json", "../../i18n/template.json")
-            .replace("import {key} from \"@uuv/runner-commons\";", "")
-            .replace("import { key } from \"@uuv/runner-commons\";", "")
+            .replace("import {key} from \"@uuv/runner-commons/wording/web\";", "")
+            .replace("import { key } from \"@uuv/runner-commons/wording/web\";", "")
             .replace("./core-engine", "../core-engine")
             .replace("../../preprocessor/run/world", "../../../preprocessor/run/world");
         const wordings = common_1.fs.readFileSync(wordingFile);
@@ -53,13 +79,5 @@ class BaseStepDefinition extends common_1.GenerateFileProcessing {
         });
         return data;
     }
-    generateWordingFiles(generatedFile, lang) {
-        const wordingFile = `${__dirname}/../assets/i18n/${lang}.json`;
-        const data = common_1.fs.readFileSync(
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        this.stepDefinitionFile, { encoding: "utf8" });
-        const updatedData = this.computeWordingFile(data, wordingFile);
-        common_1.Common.writeWordingFile(generatedFile, updatedData);
-    }
 }
 exports.BaseStepDefinition = BaseStepDefinition;

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

@@ -12,11 +12,10 @@
 * Software description: Make test writing fast, understandable by any human
 * understanding English or French.
 */
-import { GenerateFileProcessing, STEP_DEFINITION_FILE_NAME, TEST_RUNNER_ENUM } from "./common";
+import { GenerateFileProcessing } from "./common";
+import { AccessibleRole } from "./accessible-role";
 export declare class BasedRoleStepDefinition extends GenerateFileProcessing {
-    constructor(baseDir: string, runner: TEST_RUNNER_ENUM, stepDefinitionFileName: STEP_DEFINITION_FILE_NAME);
-    generatedFile: string;
     runGenerate(): void;
     generateWordingFiles(generatedFile: string, lang: string): void;
-    computeWordingFile(data: string, wordingFile: string): void;
+    computeWordingFile(data: string, wordingFile: string, definedRoles: AccessibleRole[], generatedFile: string): void;
 }

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

@@ -13,39 +13,58 @@
 * Software description: Make test writing fast, understandable by any human
 * understanding English or French.
 */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasedRoleStepDefinition = void 0;
 const common_1 = require("./common");
 const lang_enum_1 = require("./lang-enum");
+const path = __importStar(require("path"));
 class BasedRoleStepDefinition extends common_1.GenerateFileProcessing {
-    constructor(baseDir, runner, stepDefinitionFileName) {
-        super(baseDir, runner, stepDefinitionFileName);
-    }
-    generatedFile = "";
     runGenerate() {
         Object.values(lang_enum_1.LANG).forEach((lang) => {
             const generatedSubfolder = `enriched/${lang}`;
-            const generatedFolder = `${this.generatedDir}/${generatedSubfolder}`;
+            const generatedFolder = path.join(this.generatedDir, generatedSubfolder);
             common_1.Common.cleanFolderIfExists(generatedFolder);
             common_1.Common.buildDirIfNotExists(generatedFolder);
-            this.generatedFile = `${generatedFolder}/_${lang}-generated-steps-definition_$roleId.ts`;
+            const generatedFile = path.join(generatedFolder, `_${lang}-generated-steps-definition_$roleId.ts`);
             // console.debug("generatedFile template", this.generatedFile)
-            this.generateWordingFiles(this.generatedFile, lang);
+            this.generateWordingFiles(generatedFile, lang);
         });
     }
     generateWordingFiles(generatedFile, lang) {
-        const wordingFile = `${__dirname}/../assets/i18n/${lang}-enriched-wordings.json`;
-        const data = common_1.fs.readFileSync(
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        this.stepDefinitionFile, { encoding: "utf8" });
-        this.computeWordingFile(data, wordingFile);
+        const wordingFile = path.join(this.wordingFilePath, lang, `${lang}-enriched-wordings.json`);
+        const data = common_1.fs.readFileSync(this.stepDefinitionFile, { encoding: "utf8" });
+        const definedRoles = (0, common_1.getDefinedRoles)(lang);
+        this.computeWordingFile(data, wordingFile, definedRoles, generatedFile);
     }
-    computeWordingFile(data, wordingFile) {
+    computeWordingFile(data, wordingFile, definedRoles, generatedFile) {
         const dataOrigin = data;
         let dataUpdated = dataOrigin;
         const wordings = common_1.fs.readFileSync(wordingFile);
         const wordingsJson = JSON.parse(wordings.toString());
-        wordingsJson.role.forEach((role) => {
+        definedRoles.forEach((role) => {
             // console.debug("role", role)
             dataUpdated =
                 "/*******************************\n" +
@@ -55,8 +74,8 @@ class BasedRoleStepDefinition extends common_1.GenerateFileProcessing {
             dataUpdated = dataUpdated
                 .replace("../../cypress/commands", "../../../../../../cypress/commands")
                 .replace("../i18n/template.json", "../../../../i18n/template.json")
-                .replace("import { key } from \"@uuv/runner-commons\";", "")
-                .replace("import {key} from \"@uuv/runner-commons\";", "")
+                .replace("import { key } from \"@uuv/runner-commons/wording/web\";", "")
+                .replace("import {key} from \"@uuv/runner-commons/wording/web\";", "")
                 .replace("./core-engine", "../../../core-engine")
                 .replace("../../preprocessor/run/world", "../../../../../preprocessor/run/world");
             wordingsJson.enriched.forEach((conf) => {
@@ -65,9 +84,13 @@ class BasedRoleStepDefinition extends common_1.GenerateFileProcessing {
                 dataUpdated = dataUpdated
                     .replaceAll("${" + conf.key + "}", conf.wording)
                     .replaceAll("$roleId", role.id)
-                    .replaceAll("$roleName", role.name);
+                    .replaceAll("$roleName", role.name)
+                    .replaceAll("$definiteArticle", role.getDefiniteArticle())
+                    .replaceAll("$indefiniteArticle", role.getIndefiniteArticle())
+                    .replaceAll("$namedAdjective", role.namedAdjective())
+                    .replaceAll("$ofDefiniteArticle", role.getOfDefiniteArticle());
             });
-            const generatedFilename = this.generatedFile.replace("$roleId", role.id);
+            const generatedFilename = generatedFile.replace("$roleId", role.id);
             // console.debug(">>> data", dataUpdated)
             // console.debug(">>> generatedFilename", generatedFilename)
             common_1.Common.writeWordingFile(generatedFilename, dataUpdated);

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

@@ -59,8 +59,8 @@ function runGenerateDoc(destDir) {
             useGrouping: false,
         });
         const generatedFile = `${GENERATED_DIR_DOC}/${indexOfFile}-${lang}-generated-wording-description.md`;
-        const wordingBaseFile = `${__dirname}/../assets/i18n/${lang}.json`;
-        const wordingEnrichedFile = `${__dirname}/../assets/i18n/${lang}-enriched-wordings.json`;
+        const wordingBaseFile = path.join(__dirname, `../assets/i18n/web/${lang}/${lang}.json`);
+        const wordingEnrichedFile = path.join(__dirname, `../assets/i18n/web/${lang}/${lang}-enriched-wordings.json`);
         const autocompletionSuggestionFile = path.join(GENERATED_DIR_DOC, `${lang}-autocompletion-suggestion.json`);
         cleanGeneratedFilesIfExists(generatedFile, lang, indexOfFile);
         common_1.Common.cleanGeneratedFilesIfExists(autocompletionSuggestionFile);
@@ -116,8 +116,8 @@ function runGenerateDoc(destDir) {
         const dataOrigin = wordingsEnriched;
         let dataUpdated = dataOrigin;
         // console.debug("roles", wordingsEnrichedJson.role)
-        const wordingsEnrichedJson = JSON.parse(dataUpdated);
-        wordingsEnrichedJson.role.forEach((role) => {
+        const definedRoles = (0, common_1.getDefinedRoles)(lang);
+        definedRoles.forEach((role) => {
             rows.push(`### ${role.id}`);
             // console.debug("dataUpdated", dataUpdated)
             dataUpdated = dataOrigin

package/dist/step-definition-generator/generate-step-definitions.d.ts

@@ -13,4 +13,5 @@
 * understanding English or French.
 */
 import { TEST_RUNNER_ENUM } from "./common";
-export declare function generateStepDefinitionForRunner(baseDir: string, runner: TEST_RUNNER_ENUM): void;
+export declare function generateStepDefinitionForWebRunner(baseDir: string, runner: TEST_RUNNER_ENUM): void;
+export declare function generateStepDefinitionForMobileRunner(baseDir: string, runner: TEST_RUNNER_ENUM): void;

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

@@ -14,14 +14,21 @@
 * understanding English or French.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateStepDefinitionForRunner = void 0;
+exports.generateStepDefinitionForMobileRunner = exports.generateStepDefinitionForWebRunner = void 0;
 const generate_base_step_definitions_1 = require("./generate-base-step-definitions");
 const generate_based_role_step_definitions_1 = require("./generate-based-role-step-definitions");
 const common_1 = require("./common");
-function generateStepDefinitionForRunner(baseDir, runner) {
-    const cypressBaseStepDefinition = new generate_base_step_definitions_1.BaseStepDefinition(baseDir, runner, common_1.STEP_DEFINITION_FILE_NAME.BASE);
-    cypressBaseStepDefinition.runGenerate();
-    const cypressBasedRoleStepDefinition = new generate_based_role_step_definitions_1.BasedRoleStepDefinition(baseDir, runner, common_1.STEP_DEFINITION_FILE_NAME.BY_ROLE);
+function generateStepDefinitionForRunner(baseDir, runner, wordingFileRelativePath) {
+    const runnerBaseStepDefinition = new generate_base_step_definitions_1.BaseStepDefinition(baseDir, runner, common_1.STEP_DEFINITION_FILE_NAME.BASE, wordingFileRelativePath);
+    runnerBaseStepDefinition.runGenerate();
+    const cypressBasedRoleStepDefinition = new generate_based_role_step_definitions_1.BasedRoleStepDefinition(baseDir, runner, common_1.STEP_DEFINITION_FILE_NAME.BY_ROLE, wordingFileRelativePath);
     cypressBasedRoleStepDefinition.runGenerate();
 }
-exports.generateStepDefinitionForRunner = generateStepDefinitionForRunner;
+function generateStepDefinitionForWebRunner(baseDir, runner) {
+    generateStepDefinitionForRunner(baseDir, runner, "../assets/i18n/web");
+}
+exports.generateStepDefinitionForWebRunner = generateStepDefinitionForWebRunner;
+function generateStepDefinitionForMobileRunner(baseDir, runner) {
+    generateStepDefinitionForRunner(baseDir, runner, "../assets/i18n/mobile");
+}
+exports.generateStepDefinitionForMobileRunner = generateStepDefinitionForMobileRunner;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/runner-commons",
-  "version": "1.10.6",
+  "version": "1.12.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A common lib for uuv",
@@ -37,7 +37,7 @@
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "5.62.0",
     "@typescript-eslint/parser": "5.62.0",
-    "eslint": "8.54.0",
+    "eslint": "8.55.0",
     "jest": "29.7.0"
   },
   "files": [
@@ -45,6 +45,7 @@
     "dist/index.js",
     "dist/step-definition-generator/**/*",
     "dist/assets/**/*",
+    "src/assets/i18n/*/*/*.json",
     "dist/runner/**/*",
     "*.md"
   ],
@@ -53,6 +54,16 @@
       "import": "./dist/index.js",
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./wording/web": {
+      "import": "./dist/assets/i18n/web/index.js",
+      "require": "./dist/assets/i18n/web/index.js",
+      "types": "./dist/assets/i18n/web/index.d.ts"
+    },
+    "./wording/web/en": {
+      "import": "./dist/assets/i18n/web/en/index.js",
+      "require": "./dist/assets/i18n/web/en/index.js",
+      "types": "./dist/assets/i18n/web/en/index.d.ts"
     }
   }
 }

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

@@ -0,0 +1,40 @@
+{
+  "enriched": [
+    {
+      "key": "key.when.withinElement.roleAndName",
+      "description": "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",
+      "wording": "within $indefiniteArticle $roleName named {string}"
+    },
+    {
+      "key": "key.then.element.withRoleAndName",
+      "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/)",
+      "wording": "I should see $indefiniteArticle $roleName named {string}"
+    },
+    {
+      "key": "key.then.element.not.withRoleAndName",
+      "description": "Checks that an Html element does not 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/)",
+      "wording": "I should not see $indefiniteArticle $roleName named {string}"
+    },
+    {
+      "key": "key.then.element.withRoleAndNameAndContent",
+      "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), [name](https://russmaxdesign.github.io/html-elements-names/) and content",
+      "wording": "I should see $indefiniteArticle $roleName named {string} and containing {string}"
+    },
+    {
+      "key": "key.then.element.withRoleAndNameAndContentDisabled",
+      "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), [name](https://russmaxdesign.github.io/html-elements-names/) and content, and with the disabled attribute set to true",
+      "wording": "I should see $indefiniteArticle $roleName named {string} and containing {string} disabled"
+    },
+    {
+      "key": "key.then.element.withRoleAndNameAndContentEnabled",
+      "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), [name](https://russmaxdesign.github.io/html-elements-names/) and content, and with the disabled attribute set to false",
+      "wording": "I should see $indefiniteArticle $roleName named {string} and containing {string} enabled"
+    },
+    {
+      "key": "key.when.type",
+      "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}"
+    }
+  ]
+}
+