@uuv/assistant 2.73.0 → 2.73.2

package/dist/src/translator/type-translator.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Software Name : UUV
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * This software is distributed under the MIT License,
+ * see the "LICENSE" file for more details
+ *
+ * Authors: NJAKO MOLOM Louis Fredice & SERVICAL Stanley
+ * Software description: Make test writing fast, understandable by any human
+ * understanding English or French.
+ */
+import { Translator } from "./abstract-translator";
+import { TranslateSentences } from "./model";
+export declare class TypeTranslator extends Translator {
+    getSentenceFromAccessibleRoleAndName(accessibleRole: string, accessibleName: string): TranslateSentences;
+    getSentenceFromAccessibleRoleAndNameAndContent(accessibleRole: string, accessibleName: string, content: string): TranslateSentences;
+    getSentenceFromDomSelector(htmlElem: HTMLElement | SVGElement): TranslateSentences;
+    computeSentenceFromKeyRoleNameAndContent(computedKey: string, accessibleRole: string, accessibleName: string, content: string): string;
+    private buildSentencesWithRoleAndName;
+    private buildWording;
+    private getMockedDataForAccessibleRole;
+    private getMockedDataForHtmlElement;
+}

package/dist/src/translator/type-translator.js

@@ -0,0 +1,121 @@
+"use strict";
+/**
+ * Software Name : UUV
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * This software is distributed under the MIT License,
+ * see the "LICENSE" file for more details
+ *
+ * Authors: NJAKO MOLOM Louis Fredice & SERVICAL Stanley
+ * Software description: Make test writing fast, understandable by any human
+ * understanding English or French.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeTranslator = void 0;
+const abstract_translator_1 = require("./abstract-translator");
+const model_1 = require("./model");
+const stepCase = model_1.StepCaseEnum.WHEN;
+class TypeTranslator extends abstract_translator_1.Translator {
+    getSentenceFromAccessibleRoleAndName(accessibleRole, accessibleName) {
+        const response = this.initResponse();
+        response.sentences = this.buildSentencesWithRoleAndName(accessibleRole, accessibleName);
+        return response;
+    }
+    getSentenceFromAccessibleRoleAndNameAndContent(accessibleRole, accessibleName, content) {
+        const response = this.initResponse();
+        const computedKey = accessibleRole === "textbox" ? "key.when.type" : "key.when.enter";
+        const sentence = this.computeSentenceFromKeyRoleNameAndContent(computedKey, accessibleRole, accessibleName, content);
+        response.sentences = [
+            stepCase + sentence,
+        ];
+        return response;
+    }
+    getSentenceFromDomSelector(htmlElem) {
+        var _a, _b, _c;
+        const response = this.initResponse();
+        const computedKey = "key.when.withinElement.selector";
+        const sentence = this.computeSentenceFromKeyAndSelector(computedKey, abstract_translator_1.Translator.getSelector(htmlElem));
+        const clickSentence = this.getSentenceFromKey("key.when.type.withContext");
+        const resetContextSentence = this.getSentenceFromKey("key.when.resetContext");
+        const isInputHtmlorTextArea = htmlElem instanceof HTMLInputElement || htmlElem instanceof HTMLTextAreaElement;
+        const content = isInputHtmlorTextArea ?
+            /* eslint-disable  @typescript-eslint/no-explicit-any */
+            htmlElem.value :
+            (_a = htmlElem.getAttribute("value")) !== null && _a !== void 0 ? _a : (_c = (_b = htmlElem.firstChild) === null || _b === void 0 ? void 0 : _b.textContent) === null || _c === void 0 ? void 0 : _c.trim();
+        response.sentences = [
+            stepCase + sentence,
+            model_1.StepCaseEnum.AND + clickSentence.wording.replace("{string}", this.getMockedDataForHtmlElement(htmlElem, content)),
+            model_1.StepCaseEnum.AND + resetContextSentence.wording
+        ];
+        return response;
+    }
+    computeSentenceFromKeyRoleNameAndContent(computedKey, accessibleRole, accessibleName, content) {
+        return this.dictionary.getRoleBasedSentencesTemplate()
+            .filter((value) => value.key === computedKey)
+            .map(sentence => {
+            return this.dictionary.computeSentence({
+                sentence,
+                accessibleRole,
+                parameters: [content, accessibleName]
+            });
+        })[0];
+    }
+    buildSentencesWithRoleAndName(accessibleRole, accessibleName) {
+        const sentenceKey = accessibleRole === "textbox" ? "key.when.type" : "key.when.enter";
+        const wording = this.buildWording(sentenceKey, accessibleRole, accessibleName);
+        return [stepCase + wording];
+    }
+    /* eslint-disable  @typescript-eslint/no-explicit-any */
+    buildWording(computedKey, accessibleRole, accessibleName) {
+        const typeSentence = [
+            ...this.dictionary.getRoleBasedSentencesTemplate(),
+            ...this.dictionary.getBaseSentences()
+        ].find((el) => (el.key === computedKey));
+        return this.dictionary.computeSentence({
+            mock: this.getMockedDataForAccessibleRole(accessibleRole),
+            sentence: typeSentence,
+            accessibleRole,
+            parameters: [accessibleName]
+        });
+    }
+    getMockedDataForAccessibleRole(accessibleRole) {
+        var _a, _b, _c;
+        const isInputHtmlOrTextArea = this.selectedHtmlElem instanceof HTMLInputElement || this.selectedHtmlElem instanceof HTMLTextAreaElement;
+        let content = isInputHtmlOrTextArea ?
+            /* eslint-disable  @typescript-eslint/no-explicit-any */
+            this.selectedHtmlElem.value :
+            (_a = this.selectedHtmlElem.getAttribute("value")) !== null && _a !== void 0 ? _a : (_c = (_b = this.selectedHtmlElem.firstChild) === null || _b === void 0 ? void 0 : _b.textContent) === null || _c === void 0 ? void 0 : _c.trim();
+        if (!content) {
+            content = undefined;
+        }
+        if (accessibleRole === "spinbutton") {
+            return content !== null && content !== void 0 ? content : "123";
+        }
+        if (accessibleRole === "slider") {
+            return content !== null && content !== void 0 ? content : "3";
+        }
+        return content !== null && content !== void 0 ? content : "Lorem ipsum";
+    }
+    getMockedDataForHtmlElement(htmlElem, content) {
+        if (content) {
+            content = "\"" + content + "\"";
+        }
+        else {
+            content = undefined;
+        }
+        if (htmlElem.tagName.toLowerCase() === "input") {
+            if (htmlElem.getAttribute("type") === "number") {
+                return content !== null && content !== void 0 ? content : "\"123\"";
+            }
+            if (htmlElem.getAttribute("type") === "date") {
+                return content !== null && content !== void 0 ? content : "\"30/07/2024\"";
+            }
+            if (htmlElem.getAttribute("type") === "time") {
+                return content !== null && content !== void 0 ? content : "\"14:03\"";
+            }
+        }
+        return content !== null && content !== void 0 ? content : "\"Lorem ipsum\"";
+    }
+}
+exports.TypeTranslator = TypeTranslator;

package/dist/src/translator/within-translator.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Software Name : UUV
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * This software is distributed under the MIT License,
+ * see the "LICENSE" file for more details
+ *
+ * Authors: NJAKO MOLOM Louis Fredice & SERVICAL Stanley
+ * Software description: Make test writing fast, understandable by any human
+ * understanding English or French.
+ */
+import { Translator } from "./abstract-translator";
+import { TranslateSentences } from "./model";
+export declare class WithinTranslator extends Translator {
+    getSentenceFromAccessibleRoleAndName(accessibleRole: string, accessibleName: string): TranslateSentences;
+    getSentenceFromAccessibleRoleAndNameAndContent(accessibleRole: string, accessibleName: string, content: string): TranslateSentences;
+    getSentenceFromDomSelector(htmlElem: HTMLElement | SVGElement): TranslateSentences;
+}

package/dist/src/translator/within-translator.js

@@ -0,0 +1,42 @@
+"use strict";
+/**
+ * Software Name : UUV
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * This software is distributed under the MIT License,
+ * see the "LICENSE" file for more details
+ *
+ * Authors: NJAKO MOLOM Louis Fredice & SERVICAL Stanley
+ * Software description: Make test writing fast, understandable by any human
+ * understanding English or French.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WithinTranslator = void 0;
+const abstract_translator_1 = require("./abstract-translator");
+const model_1 = require("./model");
+const stepCase = model_1.StepCaseEnum.WHEN;
+class WithinTranslator extends abstract_translator_1.Translator {
+    getSentenceFromAccessibleRoleAndName(accessibleRole, accessibleName) {
+        const response = this.initResponse();
+        const computedKey = "key.when.withinElement.roleAndName";
+        const sentence = this.computeSentenceFromKeyRoleAndName(computedKey, accessibleRole, accessibleName);
+        response.sentences = [stepCase + sentence];
+        return response;
+    }
+    getSentenceFromAccessibleRoleAndNameAndContent(accessibleRole, accessibleName, content) {
+        const response = this.initResponse();
+        const computedKey = "key.when.withinElement.roleAndName";
+        const sentence = this.computeSentenceFromKeyRoleNameAndContent(computedKey, accessibleRole, accessibleName, content);
+        response.sentences = [stepCase + sentence];
+        return response;
+    }
+    getSentenceFromDomSelector(htmlElem) {
+        const response = this.initResponse();
+        const computedKey = "key.when.withinElement.selector";
+        const sentence = this.computeSentenceFromKeyAndSelector(computedKey, abstract_translator_1.Translator.getSelector(htmlElem));
+        response.sentences = [stepCase + sentence];
+        return response;
+    }
+}
+exports.WithinTranslator = WithinTranslator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/assistant",
-  "version": "2.73.0",
+  "version": "2.73.2",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "UUV Helper used to improve the life of testers and developers by generating cucumber phrases from the GUI.",
   "license": "MIT",
@@ -59,8 +59,9 @@
     "@codemirror/view": "^6.26.3",
     "@uiw/codemirror-theme-github": "^4.22.1",
     "@uiw/react-codemirror": "^4.22.1",
-    "@uuv/dictionary": "0.1.0",
+    "@uuv/dictionary": "0.1.1",
     "antd": "5.27.4",
+    "dom-accessibility-api": "0.7.0",
     "eslint-config-react-app": "7.0.1",
     "figlet": "1.8.1",
     "playwright-chromium": "1.56.1",
@@ -92,9 +93,8 @@
     "@types/testing-library__jest-dom": "5.14.9",
     "@typescript-eslint/eslint-plugin": "5.62.0",
     "@typescript-eslint/parser": "5.62.0",
-    "@uuv/playwright": "3.54.0",
+    "@uuv/playwright": "3.54.1",
     "@vitejs/plugin-react": "4.7.0",
-    "dom-accessibility-api": "0.7.0",
     "eslint-plugin-react": "7.37.5",
     "jest-environment-jsdom": "^29.5.0",
     "minimist": "1.2.8",
@@ -113,6 +113,7 @@
   "files": [
     "dist/uuv-assistant-resources.bundle.js",
     "dist/launcher/**/*",
+    "dist/src/**/*",
     "postinstall.js"
   ],
   "main": "./dist/src/index.js",