@uuv/assistant 2.72.0 → 2.73.1

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

@@ -0,0 +1,64 @@
+"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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.computeSentence = computeSentence;
+exports.isTextualNode = isTextualNode;
+const model_1 = require("./model");
+const expect_translator_1 = require("./expect-translator");
+const stepCase = model_1.StepCaseEnum.THEN;
+function computeSentence(element) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!isTextualNode(element)) {
+            return null;
+        }
+        const sentenceKey = "key.then.element.withContent";
+        const sentence = getData(element);
+        const response = {
+            suggestion: undefined,
+            sentences: []
+        };
+        response.sentences = [stepCase + new expect_translator_1.ExpectTranslator().computeSentenceFromKeyAndContent(sentenceKey, sentence)];
+        return Promise.resolve(response);
+    });
+}
+function isTextualNode(element) {
+    return [
+        "caption",
+        "code",
+        "del",
+        "em",
+        "span",
+        "div",
+        "ins",
+        "p",
+        "strong",
+        "sub",
+        "sup"
+    ].includes(element.tagName.toLowerCase())
+        && element.childNodes.length === 1
+        && element.childNodes[0].nodeName.toLowerCase() === "#text";
+}
+function getData(element) {
+    var _a;
+    return (_a = element === null || element === void 0 ? void 0 : element.childNodes[0].textContent) !== null && _a !== void 0 ? _a : "";
+}

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;